Struct TimeFormatter

pub struct TimeFormatter(/* private fields */);

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.

Implementations

impl TimeFormatter

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();

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

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

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

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

where D: DataProvider<TimeLengthsV1Marker> + DataProvider<TimeSymbolsV1Marker> + DataProvider<DecimalSymbolsV1Marker> + ?Sized,

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.

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");

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

impl Debug for TimeFormatter

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

Formats the value using the given formatter.