Struct icu_datetime::fieldsets::T

#[non_exhaustive]
pub struct T {
    pub length: Length,
    pub alignment: Option<Alignment>,
    pub time_precision: Option<TimePrecision>,
}

“3:47:50 PM” ⇒ time (locale-dependent hour cycle)

Examples

use icu::calendar::Time;
use icu::datetime::TimeFormatter;
use icu::datetime::fieldsets::T;
use icu::locale::locale;
use writeable::assert_writeable_eq;

let fmt = TimeFormatter::try_new(
    locale!("en").into(),
   T::medium(),
)
.unwrap();
let time = Time::try_new(15, 47, 50, 0).unwrap();

assert_writeable_eq!(
    fmt.format(&time),
   "3:47:50 PM"
);

Hours can be switched between 12-hour and 24-hour time via the u-hc locale keyword or DateTimeFormatterPreferences.

use icu::calendar::Time;
use icu::datetime::fieldsets::T;
use icu::datetime::TimeFormatter;
use icu::locale::locale;
use writeable::assert_writeable_eq;

// By default, en-US uses 12-hour time and fr-FR uses 24-hour time,
// but we can set overrides.

let formatter = TimeFormatter::try_new(
    locale!("en-US-u-hc-h12").into(),
    T::short().hm(),
)
.unwrap();
assert_writeable_eq!(
    formatter.format(&Time::try_new(16, 12, 20, 0).unwrap()),
    "4:12 PM"
);

let formatter = TimeFormatter::try_new(
    locale!("en-US-u-hc-h23").into(),
    T::short().hm(),
)
.unwrap();
assert_writeable_eq!(
    formatter.format(&Time::try_new(16, 12, 20, 0).unwrap()),
    "16:12"
);

let formatter = TimeFormatter::try_new(
    locale!("fr-FR-u-hc-h12").into(),
    T::short().hm(),
)
.unwrap();
assert_writeable_eq!(
    formatter.format(&Time::try_new(16, 12, 20, 0).unwrap()),
    "4:12 PM"
);

let formatter = TimeFormatter::try_new(
    locale!("fr-FR-u-hc-h23").into(),
    T::short().hm(),
)
.unwrap();
assert_writeable_eq!(
    formatter.format(&Time::try_new(16, 12, 20, 0).unwrap()),
    "16:12"
);

Hour cycles h11 and h24 are supported, too:

use icu::calendar::Time;
use icu::datetime::fieldsets::T;
use icu::datetime::TimeFormatter;
use icu::locale::locale;
use writeable::assert_writeable_eq;

let formatter = TimeFormatter::try_new(
    locale!("und-u-hc-h11").into(),
    T::short().hm(),
)
.unwrap();

assert_writeable_eq!(
    formatter.format(&Time::try_new(0, 0, 0, 0).unwrap()),
    "0:00 AM"
);

let formatter = TimeFormatter::try_new(
    locale!("und-u-hc-h24").into(),
    T::short().hm(),
)
.unwrap();

assert_writeable_eq!(
    formatter.format(&Time::try_new(0, 0, 0, 0).unwrap()),
    "24:00"
);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

length: Length

The desired length of the formatted string.

See: Length

alignment: Option<Alignment>

Whether fields should be aligned for a column-like layout.

See: Alignment

time_precision: Option<TimePrecision>

How precisely to display the time of day

See: TimePrecision

Implementations

impl T

pub const fn with_alignment(self, alignment: Alignment) -> Self

Sets the alignment option.

impl T

pub const fn with_time_precision(self, time_precision: TimePrecision) -> Self

Sets the time precision option.

pub fn hm(self) -> Self

Sets the time precision to TimePrecision::MinuteExact

impl T

pub const fn with_length(length: Length) -> Self

Creates a T skeleton with the given formatting length.

pub const fn long() -> Self

Creates a T skeleton with a long length.

pub const fn medium() -> Self

Creates a T skeleton with a medium length.

pub const fn short() -> Self

Creates a T skeleton with a short length.

impl T

pub fn with_zone_specific_long(self) -> Combo<Self, Z>

Associates this field set with a long specific non-location format time zone, as in “Pacific Daylight Time”.

pub fn with_zone_specific(self) -> Combo<Self, Zs>

Associates this field set with a short specific non-location format time zone, as in “PDT”.

pub fn with_zone_offset_long(self) -> Combo<Self, O>

Associates this field set with a long offset format time zone, as in “GMT−08:00”.

pub fn with_zone_offset(self) -> Combo<Self, Os>

Associates this field set with a short offset format time zone, as in “GMT−8”.

pub fn with_zone_generic_long(self) -> Combo<Self, V>

Associates this field set with a long generic non-location format time zone, as in “Pacific Time”.

pub fn with_zone_generic(self) -> Combo<Self, Vs>

Associates this field set with a short generic non-location format time zone, as in “PT”.

pub fn with_zone_location(self) -> Combo<Self, L>

Associates this field set with a location format time zone, as in “Los Angeles time”.

Trait Implementations

impl Clone for T

fn clone(&self) -> T

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DateTimeMarkers for T

type D = ()

Associated types for date formatting.

type T = T

Associated types for time formatting.

type Z = ()

Associated types for time zone formatting.

type GluePatternV1Marker = NeverMarker<GluePatternV1<'static>>

Marker for loading the date/time glue pattern.

impl DateTimeNamesMarker for T

type YearNames = ()

type MonthNames = ()

type WeekdayNames = ()

type DayPeriodNames = DayPeriodNamesV1Marker

type ZoneEssentials = ()

type ZoneLocations = ()

type ZoneGenericLong = ()

type ZoneGenericShort = ()

type ZoneSpecificLong = ()

type ZoneSpecificShort = ()

type MetazoneLookup = ()

impl Debug for T

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl GetField<CompositeFieldSet> for T

fn get_field(&self) -> CompositeFieldSet

Returns the value of this trait’s field T.

impl PartialEq for T

fn eq(&self, other: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TimeMarkers for T

type DayPeriodNamesV1Marker = DayPeriodNamesV1Marker

Marker for loading day period names.

type TimeSkeletonPatternsV1Marker = TimeNeoSkeletonPatternsV1Marker

Marker for loading time skeleton patterns.

type HourInput = IsoHour

Marker for resolving the day-of-month input field.

type MinuteInput = IsoMinute

Marker for resolving the day-of-week input field.

type SecondInput = IsoSecond

Marker for resolving the day-of-year input field.

type NanoSecondInput = NanoSecond

Marker for resolving the any-calendar-kind input field.

impl Copy for T

impl Eq for T

impl StructuralPartialEq for T

impl UnstableSealed for T