Struct TimeZone

#[repr(transparent)]
pub struct TimeZone(pub Subtag);

A CLDR time zone identity.

The primary definition of this type is in the icu_time crate. Other ICU4X crates re-export it for convenience.

This can be created directly from BCP-47 strings, or it can be parsed from IANA IDs.

CLDR uses difference equivalence classes than IANA. For example, Europe/Oslo is an alias to Europe/Berlin in IANA (because they agree since 1970), but these are different identities in CLDR, as we want to be able to say “Norway Time” and “Germany Time”. On the other hand Europe/Belfast and Europe/London are the same CLDR identity (“UK Time”).

See the docs on zone for more information.

use icu::locale::subtags::subtag;
use icu::time::zone::{IanaParser, TimeZone};

let parser = IanaParser::new();
assert_eq!(parser.parse("Europe/Oslo"), TimeZone(subtag!("noosl")));
assert_eq!(parser.parse("Europe/Berlin"), TimeZone(subtag!("deber")));
assert_eq!(parser.parse("Europe/Belfast"), TimeZone(subtag!("gblon")));
assert_eq!(parser.parse("Europe/London"), TimeZone(subtag!("gblon")));

Tuple Fields

0: Subtag

Implementations

impl TimeZone

pub const UNKNOWN: TimeZone

The synthetic Etc/Unknown time zone.

This is the result of parsing unknown zones. It’s important that such parsing does not fail, as new zones are added all the time, and ICU4X might not be up to date.

pub const fn is_unknown(self) -> bool

Whether this TimeZone equals TimeZone::UNKNOWN.

impl TimeZone

pub const fn with_offset(self, offset: Option<UtcOffset>) -> TimeZoneInfo<Base>

Associates this TimeZone with a UTC offset, returning a TimeZoneInfo.

pub const fn without_offset(self) -> TimeZoneInfo<Base>

Converts this TimeZone into a TimeZoneInfo without an offset.

Methods from Deref<Target = Subtag>

pub fn as_str(&self) -> &str

A helper function for displaying as a &str.

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient [Writeable] implementation. However, in order to avoid allocating a string, it is more efficient to use [Writeable] directly.

pub fn len(&self) -> usize

Returns the length of self.

Examples

use icu::locale::subtags::subtag;
let s = subtag!("foo");
assert_eq!(s.len(), 3);

Trait Implementations

impl AsULE for TimeZone

type ULE = TimeZone

The ULE type corresponding to Self.

fn to_unaligned(self) -> <TimeZone as AsULE>::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: <TimeZone as AsULE>::ULE) -> TimeZone

Converts from Self::ULE to Self.

impl Clone for TimeZone

fn clone(&self) -> TimeZone

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeZone

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

Formats the value using the given formatter.

impl Deref for TimeZone

type Target = Subtag

The resulting type after dereferencing.

fn deref(&self) -> &<TimeZone as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for TimeZone

fn deserialize<__D>( __deserializer: __D, ) -> Result<TimeZone, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<O> GetField<TimeZone> for TimeZoneInfo<O>

where O: TimeZoneModel,

fn get_field(&self) -> TimeZone

Returns the value of this trait’s field T.

impl<C, A, Z> GetField<TimeZone> for ZonedDateTime<A, Z>

where C: Calendar, A: AsCalendar<Calendar = C>, Z: GetField<TimeZone>,

fn get_field(&self) -> TimeZone

Returns the value of this trait’s field T.

impl Hash for TimeZone

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoOption<TimeZone> for TimeZone

fn into_option(self) -> Option<TimeZone>

Return self as an Option<T>

impl Ord for TimeZone

fn cmp(&self, other: &TimeZone) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TimeZone

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

fn partial_cmp(&self, other: &TimeZone) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ULE for TimeZone

fn validate_bytes(bytes: &[u8]) -> Result<(), UleError>

Validates a byte slice, &[u8].

fn parse_bytes_to_slice(bytes: &[u8]) -> Result<&[Self], UleError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime.

unsafe fn slice_from_bytes_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through Self::parse_bytes_to_slice() with success.

fn slice_as_bytes(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime.

impl<'a> Yokeable<'a> for TimeZone

where TimeZone: Sized,

type Output = TimeZone

This type MUST be Self with the 'static replaced with 'a, i.e. Self<'a>

fn transform(&self) -> &<TimeZone as Yokeable<'a>>::Output

This method must cast self between &'a Self<'static> and &'a Self<'a>.

fn transform_owned(self) -> <TimeZone as Yokeable<'a>>::Output

This method must cast self between Self<'static> and Self<'a>.

unsafe fn make(this: <TimeZone as Yokeable<'a>>::Output) -> TimeZone

This method can be used to cast away Self<'a>’s lifetime.

fn transform_mut<F>(&'a mut self, f: F)

where F: 'static + for<'b> FnOnce(&'b mut <TimeZone as Yokeable<'a>>::Output),

This method must cast self between &'a mut Self<'static> and &'a mut Self<'a>, and pass it to f.

impl<'a> ZeroMapKV<'a> for TimeZone

type Container = ZeroVec<'a, TimeZone>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = ZeroSlice<TimeZone>

type GetType = TimeZone

The type produced by Container::get()

type OwnedType = TimeZone

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl Copy for TimeZone

impl Eq for TimeZone

impl StructuralPartialEq for TimeZone