Struct icu_datetime::fieldset::Z

#[non_exhaustive]
pub struct Z {
    pub length: NeoSkeletonLength,
}

“Central Daylight Time” ⇒ time zone in specific non-location format

Examples

In DateTimeFormatter:

 use icu::calendar::{Date, Time};
 use icu::timezone::{TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
 use icu::datetime::DateTimeFormatter;
use icu::datetime::fieldset::Z;
 use icu::locale::locale;
 use tinystr::tinystr;
 use writeable::assert_try_writeable_eq;

let fmt = DateTimeFormatter::<Z>::try_new(
     &locale!("en").into(),
    Z::long(),
 )
 .unwrap();

 // Time zone info for America/Chicago in the summer
 let zone = TimeZoneBcp47Id(tinystr!(8, "uschi"))
     .with_offset("-05".parse().ok())
     .at_time((Date::try_new_iso(2022, 8, 29).unwrap(), Time::midnight()))
     .with_zone_variant(ZoneVariant::Daylight);

 assert_try_writeable_eq!(
     fmt.convert_and_format(&zone),
    "Central Daylight Time"
 );

In FixedCalendarDateTimeFormatter:

 use icu::calendar::{Date, Time};
 use icu::timezone::{TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
 use icu::calendar::Gregorian;
 use icu::datetime::FixedCalendarDateTimeFormatter;
use icu::datetime::fieldset::Z;
 use icu::locale::locale;
 use tinystr::tinystr;
 use writeable::assert_try_writeable_eq;

let fmt = FixedCalendarDateTimeFormatter::<Gregorian, Z>::try_new(
     &locale!("en").into(),
    Z::long(),
 )
 .unwrap();

 // Time zone info for America/Chicago in the summer
 let zone = TimeZoneBcp47Id(tinystr!(8, "uschi"))
     .with_offset("-05".parse().ok())
     .at_time((Date::try_new_iso(2022, 8, 29).unwrap(), Time::midnight()))
     .with_zone_variant(ZoneVariant::Daylight);

 assert_try_writeable_eq!(
     fmt.format(&zone),
    "Central Daylight Time"
 );

When a display name is unavailable, falls back to the localized offset format for short lengths, and to the location format for long lengths:

use icu::calendar::{Date, Time};
use icu::timezone::{IxdtfParser, TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
use icu::calendar::Gregorian;
use icu::datetime::FixedCalendarDateTimeFormatter;
use icu::datetime::fieldset::Z;
use icu::locale::locale;
use tinystr::tinystr;
use writeable::assert_try_writeable_eq;

// Time zone info for Europe/Istanbul in the winter
let zone = TimeZoneBcp47Id(tinystr!(8, "trist"))
    .with_offset("+02".parse().ok())
    .at_time((Date::try_new_iso(2022, 1, 29).unwrap(), Time::midnight()))
    .with_zone_variant(ZoneVariant::Standard);

let fmt = FixedCalendarDateTimeFormatter::<Gregorian, _>::try_new(
    &locale!("en").into(),
    Z::short(),
)
.unwrap();

assert_try_writeable_eq!(
    fmt.format(&zone),
    "GMT+2"
);

let fmt = FixedCalendarDateTimeFormatter::<Gregorian, _>::try_new(
    &locale!("en").into(),
    Z::long(),
)
.unwrap();

assert_try_writeable_eq!(
    fmt.format(&zone),
    "Türkiye Standard Time"
);

This style requires a ZoneVariant, so only a full time zone info can be formatted with this style. For example, TimeZoneInfo<AtTime> cannot be formatted.

use icu::calendar::{DateTime, Iso};
use icu::datetime::FixedCalendarDateTimeFormatter;
use icu::datetime::fieldset::Z;
use icu::timezone::{TimeZoneBcp47Id, UtcOffset, ZoneVariant};
use tinystr::tinystr;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let datetime = DateTime::try_new_gregorian(2024, 10, 18, 0, 0, 0).unwrap();
let time_zone_basic = TimeZoneBcp47Id(tinystr!(8, "uschi")).with_offset("-06".parse().ok());
let time_zone_at_time = time_zone_basic.at_time((datetime.date.to_iso(), datetime.time));

let formatter = FixedCalendarDateTimeFormatter::try_new(
    &locale!("en-US").into(),
    Z::medium(),
)
.unwrap();

// error[E0271]: type mismatch resolving `<AtTime as TimeZoneModel>::ZoneVariant == ZoneVariant`
formatter.format(&time_zone_at_time);

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: NeoSkeletonLength

The desired length of the formatted string.

See: NeoSkeletonLength

Implementations

impl Z

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

Creates a Z skeleton with the given formatting length.

pub const fn long() -> Self

Creates a Z skeleton with a long length.

pub const fn medium() -> Self

Creates a Z skeleton with a medium length.

pub const fn short() -> Self

Creates a Z skeleton with a short length.

Trait Implementations

impl Clone for Z

fn clone(&self) -> Z

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DateTimeMarkers for Z

type D = NeoNeverMarker

Associated types for date formatting.

type T = NeoNeverMarker

Associated types for time formatting.

type Z = Z

Associated types for time zone formatting.

type GluePatternV1Marker = NeverMarker<GluePatternV1<'static>>

Marker for loading the date/time glue pattern.

impl Debug for Z

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

Formats the value using the given formatter.

impl GetField<()> for Z

fn get_field(&self)

Returns the value of this trait’s field T.

impl GetField<CompositeFieldSet> for Z

fn get_field(&self) -> CompositeFieldSet

Returns the value of this trait’s field T.

impl GetField<NeoSkeletonLength> for Z

fn get_field(&self) -> NeoSkeletonLength

Returns the value of this trait’s field T.

impl PartialEq for Z

fn eq(&self, other: &Z) -> 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 ZoneMarkers for Z

type TimeZoneIdInput = TimeZoneBcp47Id

Marker for resolving the time zone id input field.

type TimeZoneOffsetInput = Option<UtcOffset>

Marker for resolving the time zone offset input field.

type TimeZoneVariantInput = ZoneVariant

Marker for resolving the time zone variant input field.

type TimeZoneLocalTimeInput = (Date<Iso>, Time)

Marker for resolving the time zone non-location display names, which depend on the datetime.

type EssentialsV1Marker = TimeZoneEssentialsV1Marker

Marker for loading core time zone data.

type LocationsV1Marker = LocationsV1Marker

Marker for loading location names for time zone formatting

type GenericLongV1Marker = NeverMarker<MetazoneGenericNamesV1<'static>>

Marker for loading generic long time zone names.

type GenericShortV1Marker = NeverMarker<MetazoneGenericNamesV1<'static>>

Marker for loading generic short time zone names.

type SpecificLongV1Marker = MetazoneSpecificNamesLongV1Marker

Marker for loading specific long time zone names.

type SpecificShortV1Marker = MetazoneSpecificNamesShortV1Marker

Marker for loading generic short time zone names.

type MetazonePeriodV1Marker = MetazonePeriodV1Marker

Marker for loading metazone periods.

impl Copy for Z

impl Eq for Z

impl StructuralPartialEq for Z

impl UnstableSealed for Z