struct Time::Format


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:


Constant Summary

ISO_8601_DATE = new("%F")

The ISO 8601 date format. This is just "%F".

Class Method Summary

Instance Method Summary

Instance methods inherited from struct Struct

==(other : self) : Bool ==, hash : Int32 hash, inspect(io : IO) : Nil inspect, to_s(io) to_s

Instance methods inherited from struct Value

==(other) ==, dup dup

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other)
===(other : YAML::Any)
===(other : JSON::Any)
, =~(other) =~, class class, crystal_type_id crystal_type_id, dup dup, hash hash, inspect(io : IO)
, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
, to_s
to_s(io : IO)
, to_yaml
to_yaml(io : IO)
, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, clone clone, dup dup, from_json(string_or_io) : self
from_json(string_or_io, root : String) : self
, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, nilable? nilable?, to_s(io) to_s, |(other : U.class) forall U |

Class Method Detail

def : String, kind = Time::Kind::Unspecified) #

Creates a new Time::Format with the given pattern. The given time kind 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) #

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(pull : YAML::PullParser) #

[View source]
def parse(string, kind = @kind) : 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, io : IO) #

[View source]