Struct icu_datetime::datetime::TimeFormatter

source ·
pub struct TimeFormatter(pub(crate) TimeFormatter);
Expand description

TimeFormatter is a structure of the icu::datetime component that provides time formatting only. When constructed, it uses data from the data provider, selected locale and provided preferences to collect all data necessary to format any time into that locale.

For that reason, one should think of the process of formatting a time in two steps - first, a computational heavy construction of TimeFormatter, and then fast formatting of DateTimeInput data using the instance. 📏 This item has a stack size of 1200 bytes on the stable toolchain at release date.

§Examples

use icu::calendar::DateTime;
use icu::datetime::{options::length::Time, TimeFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;

let tf =
    TimeFormatter::try_new_with_length(&locale!("en").into(), Time::Short)
        .expect("Failed to create TimeFormatter instance.");

let datetime = DateTime::try_new_gregorian_datetime(2020, 9, 1, 12, 34, 28)
    .expect("Failed to construct DateTime.");

assert_writeable_eq!(tf.format(&datetime), "12:34 PM");

This model replicates that of ICU and ECMA402.

Tuple Fields§

§0: TimeFormatter

Implementations§

source§

impl TimeFormatter

source

pub fn try_new_with_length( locale: &DataLocale, length: Time, ) -> Result<Self, DateTimeError>

Constructor that takes a selected locale and a list of preferences, then collects all compiled data necessary to format date and time values into the given locale, using the given style.

Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

§Examples
use icu::datetime::{options::length::Time, TimeFormatter};
use icu::locid::locale;

TimeFormatter::try_new_with_length(&locale!("en").into(), Time::Short)
    .unwrap();
source

pub fn try_new_with_length_with_any_provider( provider: &(impl AnyProvider + ?Sized), locale: &DataLocale, length: Time, ) -> Result<Self, DateTimeError>

A version of Self::try_new_with_length that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

source

pub fn try_new_with_length_unstable<D>( provider: &D, locale: &DataLocale, length: Time, ) -> Result<Self, DateTimeError>

A version of Self::try_new_with_length 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.
source

pub fn format<'l, T>(&'l self, value: &T) -> FormattedDateTime<'l>
where T: IsoTimeInput,

Takes a IsoTimeInput implementer and returns an instance of a FormattedDateTime that contains all information necessary to display a formatted date and operate on it.

§Examples
use icu::calendar::DateTime;
use icu::datetime::{options::length::Time, TimeFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;

let tf =
    TimeFormatter::try_new_with_length(&locale!("en").into(), Time::Short)
        .expect("Failed to create TimeFormatter instance.");

let datetime = DateTime::try_new_gregorian_datetime(2020, 9, 1, 12, 34, 28)
    .expect("Failed to construct DateTime.");

assert_writeable_eq!(tf.format(&datetime), "12:34 PM");
source

pub fn format_to_string(&self, value: &impl IsoTimeInput) -> String

Takes a IsoTimeInput implementer and returns it formatted as a string.

§Examples
use icu::calendar::DateTime;
use icu::datetime::{options::length::Time, TimeFormatter};
use icu::locid::locale;
let tf =
    TimeFormatter::try_new_with_length(&locale!("en").into(), Time::Short)
        .expect("Failed to create TimeFormatter instance.");

let datetime = DateTime::try_new_gregorian_datetime(2020, 9, 1, 12, 34, 28)
    .expect("Failed to construct DateTime.");

assert_eq!(tf.format_to_string(&datetime), "12:34 PM");

Trait Implementations§

source§

impl Debug for TimeFormatter

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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