timex

v1.0.2

Timex.Format.DateTime.Formatters.Strftime

Date formatting language defined by the strftime function from the Standard C Library.

This implementation in Elixir is mostly compatible with strftime. The exception is the absence of locale-depended results. All directives that imply textual result will produce English names and abbreviations.

A complete reference of the directives implemented here is given below.

Directive format

A directive is marked by the percent sign (%) followed by one character (<directive>). In addition, a few optional specifiers can be inserted in-between:

%<flag><width><modifier><directive>

Supported flags:

  • - - don’t pad numerical results (overrides default padding if any)
  • 0 - use zeros for padding
  • _ - use spaces for padding

  • :, :: - used only in combination with %z; see description of %:z

    and `%::z` below

<width> is a non-negative decimal number specifying the minimum field width.

<modifier> can be E or O. These are locale-sensitive modifiers, and as such they are currently ignored by this implementation.

List of all directives

  • %% - produces a single % in the output

Years and centuries

  • %Y - full year number (0000..9999)
  • %y - the last two digits of the year number (00.99)
  • %C - century number (00..99)
  • %G - year number corresponding to the date’s ISO week (0..9999)
  • %g - year number (2 digits) corresponding to the date’s ISO week (0.99)

Months

  • %m - month number (01..12)
  • %b - abbreviated month name (Jan..Dec, no padding)
  • %h - same is %b
  • %B - full month name (January..December, no padding)

Days, and days of week

  • %d - day number (01..31)
  • %e - same as %d, but padded with spaces ( 1..31)
  • %j - ordinal day of the year (001..366)
  • %u - weekday, Monday first (1..7)
  • %w - weekday, Sunday first (0..6)
  • %a - abbreviated weekday name (Mon..Sun, no padding)
  • %A - full weekday name (Monday..Sunday, no padding)

Weeks

  • %V - ISO week number (01..53)
  • %W - week number of the year, Monday first (00..53)
  • %U - week number of the year, Sunday first (00..53)

Time

  • %H - hour of the day (00..23)
  • %k - same as %H, but padded with spaces ( 0..23)
  • %I - hour of the day (1..12)
  • %l - same as %I, but padded with spaces ( 1..12)
  • %M - minutes of the hour (0..59)
  • %S - seconds of the minute (0..60)
  • %f - microseconds in zero padded decimal form, i.e. 025000
  • %s - number of seconds since UNIX epoch
  • %P - lowercase am or pm (no padding)
  • %p - uppercase AM or PM (no padding)

Time zones

  • %Z - time zone name, e.g. UTC (no padding)
  • %z - time zone offset in the form +0230 (no padding)
  • %:z - time zone offset in the form -07:30 (no padding)
  • %::z - time zone offset in the form -07:30:00 (no padding)

Compound directives

  • %D - same as %m/%d/%y
  • %F - same as %Y-%m-%d
  • %R - same as %H:%M
  • %r - same as %I:%M:%S %p
  • %T - same as %H:%M:%S
  • %v - same as %e-%b-%Y

Summary

Functions

format(date, format_string)

Callback implementation for Timex.Format.DateTime.Formatter.format/2

format!(date, format_string)

Callback implementation for Timex.Format.DateTime.Formatter.format!/2

tokenize(format_string)

See Timex.Parse.DateTime.Tokenizers.Strftime.tokenize/1

Functions

format(date, format_string)

Specs

format(%Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, String.t) ::
  {:ok, String.t} |
  {:error, term}

Callback implementation for Timex.Format.DateTime.Formatter.format/2.

format!(date, format_string)

Specs

format!(%Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, String.t) ::
  String.t |
  no_return

Callback implementation for Timex.Format.DateTime.Formatter.format!/2.

tokenize(format_string)

Specs

tokenize(String.t) ::
  {:ok, [%Timex.Parse.DateTime.Tokenizers.Directive{flags: term, modifiers: term, parser: term, type: term, value: term, weight: term, width: term}]} |
  {:error, term}

See Timex.Parse.DateTime.Tokenizers.Strftime.tokenize/1.