Struct IanaParser

pub struct IanaParser { /* private fields */ }

A parser for parsing an IANA time zone ID to a TimeZone type.

There are approximately 600 IANA identifiers and 450 TimeZone identifiers. These lists grow very slowly; in a typical year, 2-3 new identifiers are added.

This means that multiple IANA identifiers map to the same TimeZone. For example, the following four IANA identifiers all map to the same TimeZone:

• America/Fort_Wayne
• America/Indiana/Indianapolis
• America/Indianapolis
• US/East-Indiana

For each TimeZone, there is one “canonical” IANA time zone ID (for the above example, it is America/Indiana/Indianapolis). Note that the canonical identifier can change over time. For example, the identifier Europe/Kiev was renamed to the newly-added identifier Europe/Kyiv in 2022.

Examples

use icu::locale::subtags::subtag;
use icu::time::zone::IanaParser;
use icu::time::TimeZone;

let parser = IanaParser::new();

// The IANA zone "Australia/Melbourne" is the BCP-47 zone "aumel":
assert_eq!(
    parser.parse("Australia/Melbourne"),
    TimeZone(subtag!("aumel"))
);

// Parsing is ASCII-case-insensitive:
assert_eq!(
    parser.parse("australia/melbourne"),
    TimeZone(subtag!("aumel"))
);

// The IANA zone "Australia/Victoria" is an alias:
assert_eq!(
    parser.parse("Australia/Victoria"),
    TimeZone(subtag!("aumel"))
);

// The IANA zone "Australia/Boing_Boing" does not exist
// (maybe not *yet*), so it produces the special unknown
// time zone in order for this operation to be infallible:
assert_eq!(parser.parse("Australia/Boing_Boing"), TimeZone::UNKNOWN);

Implementations

impl IanaParser

pub fn new() -> IanaParserBorrowed<'static>

Creates a new IanaParser using compiled data.

See IanaParser for an example.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), ) -> Result<IanaParser, DataError>

A version of [Self :: new] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_unstable<P>(provider: &P) -> Result<IanaParser, DataError>

where P: DataProvider<TimezoneIdentifiersIanaCoreV1> + ?Sized,

A version of Self::new that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn as_borrowed(&self) -> IanaParserBorrowed<'_>

Returns a borrowed version of the parser that can be queried.

This avoids a small potential indirection cost when querying the parser.

Trait Implementations

impl AsRef<IanaParser> for IanaParser

fn as_ref(&self) -> &IanaParser

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IanaParser

fn clone(&self) -> IanaParser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IanaParser

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

Formats the value using the given formatter.