timex v0.15.0 → Overview → Timex → DateFormat → Formatters → DefaultFormatter

Timex.DateFormat.Formatters.DefaultFormatter

Summary
Functions

Date formatting language used by default by the DateFormat module.

This is a novel formatting language introduced with DateFormat. Its main advantage is simplicity and usage of mnemonics that are easy to memorize.

Directive format

A directive is an optional padding specifier followed by a mnemonic, both enclosed in braces ({ and }):

{<padding><mnemonic>}

Supported padding specifiers:

0 — pads the number with zeros. Applicable to mnemonics that produce numerical result.
_ — pads the number with spaces. Applicable to mnemonics that produce numerical result.

When padding specifier is omitted, numbers will not be padded.

List of all directives

Years and centuries

{YYYY} - full year number (0..9999)
{YY} - the last two digits of the year number (0.99)
{C} - century number (0..99)
{WYYYY} - year number corresponding to the date’s ISO week (0..9999)
{WYY} - year number (2 digits) corresponding to the date’s ISO week (0.99)

Months

{M} - month number (1..12)
{Mshort} - abbreviated month name (Jan..Dec, no padding)
{Mfull} - full month name (January..December, no padding)

Days and weekdays

{D} - day number (1..31)
{Dord} - ordinal day of the year (1..366)
{WDmon} - weekday, Monday first (1..7, no padding)
{WDsun} - weekday, Sunday first (0..6, no padding)
{WDshort} - abbreviated weekday name (Mon..Sun, no padding)
{WDfull} - full weekday name (Monday..Sunday, no padding)

Weeks

{Wiso} - ISO week number (1..53)
{Wmon} - week number of the year, Monday first (0..53)
{Wsun} - week number of the year, Sunday first (0..53)

Time

{h24} - hour of the day (0..23)
{h12} - hour of the day (1..12)
{m} - minutes of the hour (0..59)
{s} - seconds of the minute (0..60)
{s-epoch} - number of seconds since UNIX epoch
{am} - lowercase am or pm (no padding)
{AM} - uppercase AM or PM (no padding)

Time zones

{Zname} - 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

These are shortcut directives corresponding to parts of the ISO 8601 specification. The benefit of using these over manually constructed ISO formats is that these directives convert the date to UTC for you.

{ISO} - <date>T<time><offset>. Full date and time

specification (e.g. `2007-08-13T16:48:01 +0300`)

{ISOz} - <date>T<time>Z. Full date and time in UTC (e.g.
```
`2007-08-13T13:48:01Z`)
```
{ISOdate} - YYYY-MM-DD. That is, 4-digit year number, followed by
```
2-digit month and day numbers (e.g. `2007-08-13`)
```
{ISOtime} - hh:mm:ss. That is, 2-digit hour, minute, and second,
```
separated by colons (e.g. `13:04:05`). Midnight is 00 hours.
```
{ISOweek} - YYYY-Www. That is, ISO week-based year, followed by ISO
```
week number (e.g. `2007-W09`)
```
{ISOweek-day} - YYYY-Www-D. That is, an {ISOweek}, additionally
```
followed by weekday (e.g. `2007-W09-1`)
```
{ISOord} - YYYY-DDD. That is, year number, followed by the ordinal
```
day number (e.g. `2007-113`)
```

These directives provide support for miscellaneous common formats:

{RFC822} - e.g. Mon, 05 Jun 14 23:20:59 UT
{RFC822z} - e.g. Mon, 05 Jun 14 23:20:59 Z
{RFC1123} - e.g. Tue, 05 Mar 2013 23:25:19 GMT
{RFC1123z} - e.g. Tue, 05 Mar 2013 23:25:19 +0200
{RFC3339} - e.g. 2013-03-05T23:25:19+02:00
{RFC3339z} - e.g. 2013-03-05T23:25:19Z
{ANSIC} - e.g. Tue Mar 5 23:25:19 2013
{UNIX} - e.g. Tue Mar 5 23:25:19 PST 2013
{kitchen} - e.g. 3:25PM

Summary↑

format!(date, format_string)	Callback implementation for `Timex.DateFormat.Formatters.Formatter.format!/2`
format(date, format_string)	Callback implementation for `Timex.DateFormat.Formatters.Formatter.format/2`
format(date, format_string, tokenizer)	If one wants to use the default formatting semantics with a different tokenizer, this is the way
tokenize(format_string)	Callback implementation for `Timex.DateFormat.Formatters.Formatter.tokenize/1`

Functions

format(date, format_string)

(function) # ↑

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.DateFormat.Formatters.Formatter.format/2.

format(date, format_string, tokenizer)

(function) # ↑

Specs:

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

If one wants to use the default formatting semantics with a different tokenizer, this is the way.

format!(date, format_string)

(function) # ↑

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.DateFormat.Formatters.Formatter.format!/2.

tokenize(format_string)

(function) # ↑

Specs:

tokenize(String.t) :: {:ok, [%Timex.Parsers.DateFormat.Directive{format: term, len: term, match: term, max: term, min: term, optional: term, pad: term, pad_type: term, raw: term, token: term, type: term, validate: term}]} | {:error, term}

Callback implementation for Timex.DateFormat.Formatters.Formatter.tokenize/1.