struct Time::Format

• Time::Format
• Struct
• Value
• Object

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:

• %a: short day name (Sun, Mon, Tue, ...)
• %^a: short day name, upcase (SUN, MON, TUE, ...)
• %A: day name (Sunday, Monday, Tuesday, ...)
• %^A: day name, upcase (SUNDAY, MONDAY, TUESDAY, ...)
• %b: short month name (Jan, Feb, Mar, ...)
• %^b: short month name, upcase (JAN, FEB, MAR, ...)
• %B: month name (January, February, March, ...)
• %^B: month name, upcase (JANUARY, FEBRUARY, MARCH, ...)
• %c: date and time (Tue Apr 5 10:26:19 2016)
• %C: year divided by 100
• %d: day of month, zero padded (01, 02, ...)
• %-d: day of month (1, 2, ..., 31)
• %D: date (04/05/16)
• %e: day of month, blank padded (" 1", " 2", ..., "10", "11", ...)
• %F: ISO 8601 date (2016-04-05)
• %h: (same as %b) short month name (Jan, Feb, Mar, ...)
• %H: hour of the day, 24-hour clock, zero padded (00, 01, ..., 24)
• %I: hour of the day, 12-hour clock, zero padded (00, 01, ..., 12)
• %j: day of year, zero padded (001, 002, ..., 365)
• %k: hour of the day, 24-hour clock, blank padded (" 0", " 1", ..., "24")
• %l: hour of the day, 12-hour clock, blank padded (" 0", " 1", ..., "12")
• %L: milliseconds, zero padded (000, 001, ..., 999)
• %m: month number, zero padded (01, 02, ..., 12)
• %_m: month number, blank padded (" 1", " 2", ..., "12")
• %-m: month number (1, 2, ..., 12)
• %M: minute, zero padded (00, 01, 02, ..., 59)
• %p: am-pm (lowercase)
• %P: AM-PM (uppercase)
• %r: 12-hour time (03:04:05 AM)
• %R: 24-hour time (13:04)
• %s: seconds since unix epoch (see Time.epoch)
• %S: seconds, zero padded (00, 01, ..., 59)
• %T: 24-hour time (13:04:05)
• %u: day of week (Monday is 1, 1..7)
• %w: day of week (Sunday is 0, 0..6)
• %x: (same as %D) date (04/05/16)
• %X: (same as %T) 24-hour time (13:04:05)
• %y: year modulo 100
• %Y: year, zero padded
• %z: time zone as hour and minute offset from UTC (+0900)
• %:z: time zone as hour and minute offset from UTC with a colon (+09:00)
• %::z: time zone as hour, minute and second offset from UTC with a colon (+09:00:00)

Defined in:

Constant Summary

ISO_8601_DATE = new("%F")

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

ISO_8601_DATE_TIME = new("%FT%X%z")

The ISO 8601 datetime format. This is just "%FT%X%z".

Constructors

• .new(pattern : String, kind = Time::Kind::Unspecified)

  Creates a new Time::Format with the given pattern.

Instance Method Summary

• #format(time : Time, io : IO)

  Formats a Time into the given io.

• #format(time : Time) : String

  Turns a Time into a String.

• #from_json(pull : JSON::PullParser)
• #from_yaml(pull : YAML::PullParser)
• #parse(string, kind = @kind) : Time

  Parses a string into a Time.

• #pattern : String

  Returns the string pattern of this format.

• #to_json(value : Time, json : JSON::Builder)
• #to_yaml(value : Time, yaml : YAML::Builder)

Constructor Detail

Instance Method Detail