struct Time::Format

Overview

Specifies the format to convert a Time to and from a String.

The pattern of a format is a String with directives. Directives being with a percent (%) character. Any text not listed as a directive will be passed/parsed through the output/input string.

The directives are:

Defined in:

time/format/pattern.cr
time/format/formatter.cr
time/format/parser.cr
time/format.cr
time/format/custom/rfc_2822.cr
time/format/custom/http_date.cr
time/format/custom/iso_8601.cr
time/format/custom/rfc_3339.cr
time/format/custom/yaml_date.cr
json/from_json.cr
json/to_json.cr
yaml/from_yaml.cr
yaml/to_yaml.cr

Constructors

Instance Method Summary

Instance methods inherited from struct Struct

==(other) : Bool ==, hash(hasher) hash, inspect(io : IO) : Nil inspect, pretty_print(pp) : Nil pretty_print, to_s(io : IO) : Nil to_s

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s : String
to_s(io : IO) : Nil
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

def self.new(pattern : String, location : Location? = nil) #

Creates a new Time::Format with the given pattern. The given time location will be used when parsing a Time and no time zone is found in it.


[View source]

Instance Method Detail

def format(time : Time, io : IO) : Nil #

Formats a Time into the given io.


[View source]
def format(time : Time) : String #

Turns a Time into a String.


[View source]
def from_json(pull : JSON::PullParser) #

[View source]
def from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Time #

[View source]
def parse(string, location = @location) : Time #

Parses a string into a Time.


[View source]
def pattern : String #

Returns the string pattern of this format.


[View source]
def to_json(value : Time, json : JSON::Builder) #

[View source]
def to_yaml(value : Time, yaml : YAML::Nodes::Builder) #

[View source]