Struct icu_datetime::datetime::TypedDateFormatter
source · pub struct TypedDateFormatter<C>(pub(crate) DateFormatter, PhantomData<C>);
Expand description
TypedDateFormatter
is a formatter capable of formatting
dates from a calendar selected at compile time. For the difference between this
and DateFormatter
, please read the crate root docs.
When constructed, it uses data from the data provider, selected locale and provided options to collect all data necessary to format any dates into that locale.
For that reason, one should think of the process of formatting a date in two steps - first, a computational
heavy construction of TypedDateFormatter
, and then fast formatting of DateInput
data using the instance.
📏 This item has a stack size of 4400 bytes on the stable toolchain at release date.
§Examples
use icu::calendar::{Date, Gregorian};
use icu::datetime::{options::length, TypedDateFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;
let df = TypedDateFormatter::<Gregorian>::try_new_with_length(
&locale!("en").into(),
length::Date::Full,
)
.expect("Failed to create TypedDateFormatter instance.");
let date = Date::try_new_gregorian_date(2020, 9, 1)
.expect("Failed to construct Date.");
assert_writeable_eq!(df.format(&date), "Tuesday, September 1, 2020");
This model replicates that of ICU
and ECMA402
.
Tuple Fields§
§0: DateFormatter
§1: PhantomData<C>
Implementations§
source§impl<C: CldrCalendar> TypedDateFormatter<C>
impl<C: CldrCalendar> TypedDateFormatter<C>
sourcepub fn try_new_with_length(
locale: &DataLocale,
length: Date,
) -> Result<Self, DateTimeError>where
Baked: DataProvider<<C as CldrCalendar>::DateLengthsV1Marker> + DataProvider<<C as CldrCalendar>::DateSymbolsV1Marker>,
pub fn try_new_with_length(
locale: &DataLocale,
length: Date,
) -> Result<Self, DateTimeError>where
Baked: DataProvider<<C as CldrCalendar>::DateLengthsV1Marker> + DataProvider<<C as CldrCalendar>::DateSymbolsV1Marker>,
Constructor that takes a selected locale and a list of options, then collects all compiled data necessary to format date and time values into the given locale.
✨ Enabled with the compiled_data
Cargo feature.
§Examples
use icu::calendar::Date;
use icu::calendar::Gregorian;
use icu::datetime::{options::length, TypedDateFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;
let formatter = TypedDateFormatter::<Gregorian>::try_new_with_length(
&locale!("en").into(),
length::Date::Full,
)
.unwrap();
assert_writeable_eq!(
formatter.format(&Date::try_new_gregorian_date(2022, 8, 29).unwrap()),
"Monday, August 29, 2022",
);
If the locale has a calendar keyword, the keyword is ignored in favor of the
type parameter on the TypedDateFormatter
. To obey the calendar keyword,
use DateFormatter
instead.
use icu::calendar::indian::Indian;
use icu::calendar::Date;
use icu::datetime::{options::length, TypedDateFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;
let formatter = TypedDateFormatter::<Indian>::try_new_with_length(
&locale!("en-u-ca-japanese").into(),
length::Date::Full,
)
.unwrap();
// Indian format from type wins over locale keyword
assert_writeable_eq!(
formatter.format(&Date::try_new_indian_date(1944, 6, 7).unwrap()),
"Monday, Bhadra 7, 1944 Saka",
);
sourcepub fn try_new_with_length_with_any_provider(
provider: &(impl AnyProvider + ?Sized),
locale: &DataLocale,
length: Date,
) -> Result<Self, DateTimeError>
pub fn try_new_with_length_with_any_provider( provider: &(impl AnyProvider + ?Sized), locale: &DataLocale, length: Date, ) -> Result<Self, DateTimeError>
A version of Self::try_new_with_length
that uses custom data provided by an AnyProvider
.
sourcepub fn try_new_with_length_unstable<D>(
provider: &D,
locale: &DataLocale,
length: Date,
) -> Result<Self, DateTimeError>where
D: DataProvider<<C as CldrCalendar>::DateSymbolsV1Marker> + DataProvider<<C as CldrCalendar>::DateLengthsV1Marker> + DataProvider<DecimalSymbolsV1Marker> + DataProvider<OrdinalV1Marker> + DataProvider<WeekDataV1Marker> + ?Sized,
pub fn try_new_with_length_unstable<D>(
provider: &D,
locale: &DataLocale,
length: Date,
) -> Result<Self, DateTimeError>where
D: DataProvider<<C as CldrCalendar>::DateSymbolsV1Marker> + DataProvider<<C as CldrCalendar>::DateLengthsV1Marker> + DataProvider<DecimalSymbolsV1Marker> + DataProvider<OrdinalV1Marker> + DataProvider<WeekDataV1Marker> + ?Sized,
A version of Self::try_new_with_length
that uses custom data provided by a DataProvider
.
sourcepub fn format<'l, T>(&'l self, value: &T) -> FormattedDateTime<'l>where
T: DateInput<Calendar = C>,
pub fn format<'l, T>(&'l self, value: &T) -> FormattedDateTime<'l>where
T: DateInput<Calendar = C>,
Takes a DateTimeInput
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::{Date, Gregorian};
use icu::datetime::{options::length, TypedDateFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;
let df = TypedDateFormatter::<Gregorian>::try_new_with_length(
&locale!("en").into(),
length::Date::Full,
)
.expect("Failed to create TypedDateFormatter instance.");
let date = Date::try_new_gregorian_date(2020, 9, 1)
.expect("Failed to construct Date.");
assert_writeable_eq!(df.format(&date), "Tuesday, September 1, 2020");
sourcepub fn format_to_string(&self, value: &impl DateInput<Calendar = C>) -> String
pub fn format_to_string(&self, value: &impl DateInput<Calendar = C>) -> String
Takes a DateTimeInput
implementer and returns it formatted as a string.
§Examples
use icu::calendar::{Date, Gregorian};
use icu::datetime::{options::length, TypedDateFormatter};
use icu::locid::locale;
let df = TypedDateFormatter::<Gregorian>::try_new_with_length(
&locale!("en").into(),
length::Date::Short,
)
.expect("Failed to create TypedDateTimeFormatter instance.");
let date = Date::try_new_gregorian_date(2020, 9, 1)
.expect("Failed to construct Date.");
assert_eq!(df.format_to_string(&date), "9/1/20");
Trait Implementations§
Auto Trait Implementations§
impl<C> Freeze for TypedDateFormatter<C>
impl<C> RefUnwindSafe for TypedDateFormatter<C>where
C: RefUnwindSafe,
impl<C> !Send for TypedDateFormatter<C>
impl<C> !Sync for TypedDateFormatter<C>
impl<C> Unpin for TypedDateFormatter<C>where
C: Unpin,
impl<C> UnwindSafe for TypedDateFormatter<C>where
C: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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