Struct icu_datetime::neo::TypedNeoFormatter

pub struct TypedNeoFormatter<C: CldrCalendar, FSet: DateTimeNamesMarker> { /* private fields */ }

TypedNeoFormatter is a formatter capable of formatting dates and/or times from a calendar selected at compile time.

For more details, please read the crate root docs.

📏 This item has a stack size of 496 bytes on the stable toolchain at release date.

Implementations

impl<C: CldrCalendar, FSet> TypedNeoFormatter<C, FSet>

where FSet::D: TypedDateDataMarkers<C>, FSet::T: TimeMarkers, FSet::Z: ZoneMarkers, FSet: GetField<FSet::LengthOption> + GetField<FSet::AlignmentOption> + GetField<FSet::YearStyleOption> + GetField<FSet::FractionalSecondDigitsOption> + DateTimeMarkers + HasConstComponents,

pub fn try_new(locale: &DataLocale, field_set: FSet) -> Result<Self, LoadError>

where Baked: Sized + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::YearNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::MonthNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::DateSkeletonPatternsV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::WeekdayNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::DayPeriodNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::TimeSkeletonPatternsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::EssentialsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::LocationsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::MetazonePeriodV1Marker> + DataProvider<FSet::GluePatternV1Marker>,

Creates a new TypedNeoFormatter from compiled data with datetime components specified at build time.

Use this constructor for optimal data size and memory use if you know the required datetime components at build time. If you do not know the datetime components until runtime, use a with_components constructor.

Examples

Basic usage:

use icu::calendar::Date;
use icu::calendar::Gregorian;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_marker::NeoYearMonthDayMarker;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let formatter = TypedNeoFormatter::try_new(
    &locale!("es-MX").into(),
    NeoYearMonthDayMarker::with_length(NeoSkeletonLength::Long),
)
.unwrap();

assert_try_writeable_eq!(
    formatter.format(&Date::try_new_gregorian(2023, 12, 20).unwrap()),
    "20 de diciembre de 2023"
);

pub fn try_new_with_any_provider<P>( provider: &P, locale: &DataLocale, options: FSet, ) -> Result<Self, LoadError>

where P: AnyProvider + ?Sized,

A version of [Self :: try_new] that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider<P>( provider: &P, locale: &DataLocale, options: FSet, ) -> Result<Self, LoadError>

where P: BufferProvider + ?Sized,

A version of [Self :: try_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, locale: &DataLocale, field_set: FSet, ) -> Result<Self, LoadError>

where P: ?Sized + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::YearNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::MonthNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::DateSkeletonPatternsV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::WeekdayNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::DayPeriodNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::TimeSkeletonPatternsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::EssentialsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::LocationsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::MetazonePeriodV1Marker> + DataProvider<FSet::GluePatternV1Marker> + DataProvider<DecimalSymbolsV1Marker>,

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

impl<C: CldrCalendar, FSet> TypedNeoFormatter<C, FSet>

where FSet::D: TypedDateDataMarkers<C>, FSet::T: TimeMarkers, FSet::Z: ZoneMarkers, FSet: GetField<FSet::LengthOption> + GetField<FSet::AlignmentOption> + GetField<FSet::YearStyleOption> + GetField<FSet::FractionalSecondDigitsOption> + DateTimeMarkers + IsRuntimeComponents,

pub fn try_new_with_skeleton( locale: &DataLocale, skeleton: FSet, ) -> Result<Self, LoadError>

where Baked: Sized + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::YearNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::MonthNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::DateSkeletonPatternsV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::WeekdayNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::DayPeriodNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::TimeSkeletonPatternsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::EssentialsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::LocationsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::MetazonePeriodV1Marker> + DataProvider<FSet::GluePatternV1Marker>,

Creates a new TypedNeoFormatter from compiled data with datetime components specified at runtime.

If you know the datetime components at build time, use TypedNeoFormatter::try_new for smaller data size and memory use.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

Examples

Date components:

use icu::calendar::Date;
use icu::calendar::Gregorian;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_skeleton::NeoDateComponents;
use icu::datetime::neo_skeleton::NeoDateSkeleton;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let fmt = TypedNeoFormatter::<Gregorian, _>::try_new_with_skeleton(
    &locale!("es-MX").into(),
    NeoDateSkeleton::for_length_and_components(
        NeoSkeletonLength::Medium,
        NeoDateComponents::DayWeekday,
    ),
)
.unwrap();
let dt = Date::try_new_gregorian(2024, 1, 10).unwrap();

assert_try_writeable_eq!(fmt.format(&dt), "mié 10");

Calendar period components:

use icu::calendar::Date;
use icu::calendar::Gregorian;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_skeleton::NeoCalendarPeriodComponents;
use icu::datetime::neo_skeleton::NeoCalendarPeriodSkeleton;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let fmt = TypedNeoFormatter::<Gregorian, _>::try_new_with_skeleton(
    &locale!("es-MX").into(),
    NeoCalendarPeriodSkeleton::for_length_and_components(
        NeoSkeletonLength::Medium,
        NeoCalendarPeriodComponents::YearMonth,
    ),
)
.unwrap();
let dt = Date::try_new_gregorian(2024, 1, 10).unwrap();

assert_try_writeable_eq!(fmt.format(&dt), "ene 2024");

Time components:

use icu::calendar::Gregorian;
use icu::calendar::Time;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::datetime::neo_skeleton::NeoTimeComponents;
use icu::datetime::neo_skeleton::NeoTimeSkeleton;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let fmt = TypedNeoFormatter::<Gregorian, _>::try_new_with_skeleton(
    &locale!("es-MX").into(),
    NeoTimeSkeleton::for_length_and_components(
        NeoSkeletonLength::Medium,
        NeoTimeComponents::Hour,
    ),
)
.unwrap();
let dt = Time::try_new(16, 20, 0, 0).unwrap();

assert_try_writeable_eq!(fmt.format(&dt), "04 p.m.");

Date and time components:

use icu::calendar::DateTime;
use icu::calendar::Gregorian;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_skeleton::NeoDateComponents;
use icu::datetime::neo_skeleton::NeoDateTimeComponents;
use icu::datetime::neo_skeleton::NeoDateTimeSkeleton;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::datetime::neo_skeleton::NeoTimeComponents;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let fmt = TypedNeoFormatter::<Gregorian, _>::try_new_with_skeleton(
    &locale!("es-MX").into(),
    NeoDateTimeSkeleton::for_length_and_components(
        NeoSkeletonLength::Long,
        NeoDateTimeComponents::DateTime(
            NeoDateComponents::Weekday,
            NeoTimeComponents::HourMinute,
        ),
    ),
)
.unwrap();
let dt =
    DateTime::try_new_gregorian(2024, 1, 10, 16, 20, 0).unwrap();

assert_try_writeable_eq!(fmt.format(&dt), "miércoles 4:20 p.m.");

pub fn try_new_with_skeleton_with_any_provider<P>( provider: &P, locale: &DataLocale, skeleton: FSet, ) -> Result<Self, LoadError>

where P: AnyProvider + ?Sized,

A version of [Self :: try_new_with_skeleton] that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_with_skeleton_with_buffer_provider<P>( provider: &P, locale: &DataLocale, skeleton: FSet, ) -> Result<Self, LoadError>

where P: BufferProvider + ?Sized,

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_with_skeleton_unstable<P>( provider: &P, locale: &DataLocale, skeleton: FSet, ) -> Result<Self, LoadError>

where P: ?Sized + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::YearNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::MonthNamesV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::DateSkeletonPatternsV1Marker> + DataProvider<<FSet::D as TypedDateDataMarkers<C>>::WeekdayNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::DayPeriodNamesV1Marker> + DataProvider<<FSet::T as TimeMarkers>::TimeSkeletonPatternsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::EssentialsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::LocationsV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::GenericShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificLongV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::SpecificShortV1Marker> + DataProvider<<FSet::Z as ZoneMarkers>::MetazonePeriodV1Marker> + DataProvider<FSet::GluePatternV1Marker> + DataProvider<DecimalSymbolsV1Marker>,

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

impl<C: CldrCalendar, FSet: DateTimeMarkers> TypedNeoFormatter<C, FSet>

where FSet::D: DateInputMarkers, FSet::T: TimeMarkers, FSet::Z: ZoneMarkers,

pub fn format<I>(&self, input: &I) -> FormattedNeoDateTime<'_>

where I: ?Sized + IsInCalendar<C> + AllInputMarkers<FSet>,

Formats a datetime. Calendars and fields must match at compile time.

Examples

Mismatched calendars will not compile:

use icu::calendar::Date;
use icu::calendar::cal::Buddhist;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_marker::NeoYearMonthDayMarker;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::locale::locale;

let formatter =
    TypedNeoFormatter::<Buddhist, _>::try_new(
        &locale!("es-MX").into(),
        NeoYearMonthDayMarker::with_length(NeoSkeletonLength::Long),
    )
    .unwrap();

// type mismatch resolving `<Gregorian as AsCalendar>::Calendar == Buddhist`
formatter.format(&Date::try_new_gregorian(2023, 12, 20).unwrap());

A time cannot be passed into the formatter when a date is expected:

use icu::calendar::Time;
use icu::calendar::Gregorian;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_marker::NeoYearMonthDayMarker;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::locale::locale;

let formatter =
    TypedNeoFormatter::<Gregorian, _>::try_new(
        &locale!("es-MX").into(),
        NeoYearMonthDayMarker::with_length(NeoSkeletonLength::Long),
    )
    .unwrap();

// the trait `GetField<AnyCalendarKind>`
// is not implemented for `icu::icu_calendar::Time`
formatter.format(&Time::try_new(0, 0, 0, 0).unwrap());

impl<C: CldrCalendar, FSet: DateTimeMarkers> TypedNeoFormatter<C, FSet>

pub fn into_formatter(self, calendar: C) -> NeoFormatter<FSet>

where C: IntoAnyCalendar,

Make this TypedNeoFormatter adopt a calendar so it can format any date.

This is useful if you need a NeoFormatter but know the calendar system ahead of time, so that you do not need to link extra data you aren’t using.

Examples

use icu::calendar::Date;
use icu::calendar::cal::Hebrew;
use icu::datetime::neo::TypedNeoFormatter;
use icu::datetime::neo_marker::NeoYearMonthDayMarker;
use icu::datetime::neo_skeleton::NeoSkeletonLength;
use icu::locale::locale;
use writeable::assert_try_writeable_eq;

let formatter = TypedNeoFormatter::try_new(
    &locale!("en").into(),
    NeoYearMonthDayMarker::with_length(NeoSkeletonLength::Long),
)
.unwrap()
.into_formatter(Hebrew::new());

let date = Date::try_new_iso(2024, 10, 14).unwrap();

assert_try_writeable_eq!(
    formatter.convert_and_format(&date),
    "12 Tishri 5785"
);

Trait Implementations

impl<C: Debug + CldrCalendar, FSet: Debug + DateTimeNamesMarker> Debug for TypedNeoFormatter<C, FSet>

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

Formats the value using the given formatter.