Module icu::datetime::fieldsets

Expand description

All available field sets for datetime formatting.

Each field set is a struct containing options specified to that field set. The fields can either be set directly or via helper functions.

This module contains static field sets, which deliver the smallest binary size. If the field set is not known until runtime, use a dynamic field set: enums

§What is a Field Set?

A field set determines what datetime fields should be printed in the localized output.

Examples of field sets include:

Year, month, and day (YMD)
Weekday and time (ET)

Field sets fit into four categories:

Date: fields that specify a particular day in time.
Calendar period: fields that specify a span of time greater than a day.
Time: fields that specify a time within a day.
Zone: fields that specify a time zone or offset from UTC.

Certain combinations of field sets are allowed, too. See Combo.

§Examples

Two ways to configure the same field set:

use icu::datetime::fieldsets::YMDT;
use icu::datetime::options::{Alignment, TimePrecision, YearStyle};

let field_set_1 = YMDT::long()
    .with_year_style(YearStyle::Full)
    .with_alignment(Alignment::Column)
    .with_time_precision(TimePrecision::MinuteExact);

let mut field_set_2 = YMDT::long();
field_set_2.year_style = Some(YearStyle::Full);
field_set_2.alignment = Some(Alignment::Column);
field_set_2.time_precision = Some(TimePrecision::MinuteExact);

assert_eq!(field_set_1, field_set_2);

Modules§

enums
Enumerations over field sets.
serde
🚧 [Experimental] Types for dealing with serialization of semantic skeletons.

Structs§

Combo
Struct for combining date/time fields with zone fields.
D
“17” ⇒ day of month (standalone)
DE
“17 Friday” ⇒ day of month and weekday
DET
“17 Friday, 3:47:50 PM” ⇒ day of month and weekday with time
DT
“17, 3:47:50 PM” ⇒ day of month (standalone) with time
E
“Friday” ⇒ weekday (standalone)
ET
“Friday 3:47:50 PM” ⇒ weekday (standalone) with time
L
“Chicago Time” ⇒ time zone in location format
M
“May” ⇒ month (standalone)
MD
“May 17” ⇒ month and day
MDE
“Fri, May 17” ⇒ month, day, and weekday
MDET
“Fri, May 17, 3:47:50 PM” ⇒ month, day, and weekday with time
MDT
“May 17, 3:47:50 PM” ⇒ month and day with time
O
“GMT-5” ⇒ UTC offset
T
“3:47:50 PM” ⇒ time (locale-dependent hour cycle)
V
“Central Time” ⇒ time zone in generic non-location format
Vs
“CT” ⇒ time zone in generic non-location format (only short)
Y
“2024” ⇒ year (standalone)
YM
“May 2024” ⇒ year and month
YMD
“5/17/24” ⇒ year, month, and day
YMDE
“Fri, 5/17/24” ⇒ year, month, day, and weekday
YMDET
“Fri, 5/17/24, 3:47:50 PM” ⇒ year, month, day, and weekday with time
YMDT
“5/17/24, 3:47:50 PM” ⇒ year, month, and day with time
Z
“Central Daylight Time” ⇒ time zone in specific non-location format
Zs
“CDT” ⇒ time zone in specific non-location format (only short)

Type Aliases§