Struct icu::datetime::fieldset::Z

source ·
#[non_exhaustive]
pub struct Z { pub length: NeoSkeletonLength, }
Expand description

“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)§

This struct is marked as 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§

source§

impl Z

source

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

Creates a Z skeleton with the given formatting length.

source

pub const fn long() -> Z

Creates a Z skeleton with a long length.

source

pub const fn medium() -> Z

Creates a Z skeleton with a medium length.

source

pub const fn short() -> Z

Creates a Z skeleton with a short length.

Trait Implementations§

source§

impl Clone for Z

source§

fn clone(&self) -> Z

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl DateTimeMarkers for Z

source§

type D = NeoNeverMarker

Associated types for date formatting. Read more
source§

type T = NeoNeverMarker

Associated types for time formatting. Read more
source§

type Z = Z

Associated types for time zone formatting. Read more
source§

type GluePatternV1Marker = NeverMarker<GluePatternV1<'static>>

Marker for loading the date/time glue pattern.
source§

impl Debug for Z

source§

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

Formats the value using the given formatter. Read more
source§

impl GetField<()> for Z

source§

fn get_field(&self)

Returns the value of this trait’s field T.
source§

impl GetField<CompositeFieldSet> for Z

source§

fn get_field(&self) -> CompositeFieldSet

Returns the value of this trait’s field T.
source§

impl GetField<NeoSkeletonLength> for Z

source§

fn get_field(&self) -> NeoSkeletonLength

Returns the value of this trait’s field T.
source§

impl PartialEq for Z

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl ZoneMarkers for Z

source§

type TimeZoneIdInput = TimeZoneBcp47Id

Marker for resolving the time zone id input field.
source§

type TimeZoneOffsetInput = Option<UtcOffset>

Marker for resolving the time zone offset input field.
source§

type TimeZoneVariantInput = ZoneVariant

Marker for resolving the time zone variant input field.
source§

type TimeZoneLocalTimeInput = (Date<Iso>, Time)

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

type EssentialsV1Marker = TimeZoneEssentialsV1Marker

Marker for loading core time zone data.
source§

type LocationsV1Marker = LocationsV1Marker

Marker for loading location names for time zone formatting
source§

type GenericLongV1Marker = NeverMarker<MetazoneGenericNamesV1<'static>>

Marker for loading generic long time zone names.
source§

type GenericShortV1Marker = NeverMarker<MetazoneGenericNamesV1<'static>>

Marker for loading generic short time zone names.
source§

type SpecificLongV1Marker = MetazoneSpecificNamesLongV1Marker

Marker for loading specific long time zone names.
source§

type SpecificShortV1Marker = MetazoneSpecificNamesShortV1Marker

Marker for loading generic short time zone names.
source§

type MetazonePeriodV1Marker = MetazonePeriodV1Marker

Marker for loading metazone periods.
source§

impl Copy for Z

source§

impl Eq for Z

source§

impl StructuralPartialEq for Z

source§

impl UnstableSealed for Z

Auto Trait Implementations§

§

impl Freeze for Z

§

impl RefUnwindSafe for Z

§

impl Send for Z

§

impl Sync for Z

§

impl Unpin for Z

§

impl UnwindSafe for Z

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> GetField<T> for T
where T: Copy,

source§

fn get_field(&self) -> T

Returns the value of this trait’s field T.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T
where T: Send + Sync,