icu_datetime 2.2.0

// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
#![cfg_attr(not(any(test, doc)), no_std)]
#![cfg_attr(
    not(test),
    deny(
        clippy::indexing_slicing,
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
    )
)]
#![warn(missing_docs)]

//! Localized formatting of dates, times, and time zones.
//!
//! This module is published as its own crate ([`icu_datetime`](https://docs.rs/icu_datetime/latest/icu_datetime/))
//! and as part of the [`icu`](https://docs.rs/icu/latest/icu/) crate. See the latter for more details on the ICU4X project.
//!
//! ICU4X datetime formatting follows the Unicode UTS 35 standard for [Semantic Skeletons](https://unicode.org/reports/tr35/tr35-dates.html#Semantic_Skeletons).
//! First you choose a _field set_, then you configure the formatting _options_ to your desired context.
//!
//! 1. Field Sets: [`icu::datetime::fieldsets`](fieldsets)
//! 2. Options: [`icu::datetime::options`](options)
//!
//! ICU4X supports formatting in over one dozen _calendar systems_, including Gregorian, Buddhist,
//! Hijri, and more. The calendar system is usually derived from the locale, but it can also be
//! specified explicitly.
//!
//! The main formatter in this crate is [`DateTimeFormatter`], which supports all field sets,
//! options, and calendar systems. Additional formatter types are available to developers in
//! resource-constrained environments.
//!
//! The formatters accept input types from the [`calendar`](icu_calendar) and
//! [`timezone`](icu_time) crates (Also reexported from the [`input`] module of this crate):
//!
//! 1. [`Date`](icu_calendar::Date)
//! 2. [`DateTime`](icu_time::DateTime)
//! 3. [`Time`](icu_time::Time)
//! 4. [`UtcOffset`](icu_time::zone::UtcOffset)
//! 5. [`TimeZoneInfo`](icu_time::TimeZoneInfo)
//! 6. [`ZonedDateTime`](icu_time::ZonedDateTime)
//! 7. And datetime types from third party crates; see [`input::unstable_third_party`].
//!
//! Not all inputs are valid for all field sets.
//!
//! # Examples
//!
//! ```
//! use icu::datetime::fieldsets;
//! use icu::datetime::input::Date;
//! use icu::datetime::input::{DateTime, Time};
//! use icu::datetime::DateTimeFormatter;
//! use icu::locale::{locale, Locale};
//! use writeable::assert_writeable_eq;
//!
//! // Field set for year, month, day, hour, and minute with a medium length:
//! let field_set_with_options = fieldsets::YMD::medium().with_time_hm();
//!
//! // Create a formatter for Argentinian Spanish:
//! let locale = locale!("es-AR");
//! let dtf = DateTimeFormatter::try_new(locale.into(), field_set_with_options)
//!     .unwrap();
//!
//! // Format something:
//! let datetime = DateTime {
//!     date: Date::try_new_iso(2025, 1, 15).unwrap(),
//!     time: Time::try_new(16, 9, 35, 0).unwrap(),
//! };
//! let formatted_date = dtf.format(&datetime);
//!
//! assert_writeable_eq!(formatted_date, "15 de ene de 2025, 4:09 p. m.");
//! ```
//!
//! # Binary Size Considerations
//!
//! ## Avoid linking unnecessary field sets data
//!
//! There are two APIs for fieldsets:
//! * "static" field sets, like [`fieldsets::YMD`], where each field set is a *type*.
//! * "dynamic" field sets, like [`fieldsets::enums::CompositeFieldSet`], where each field set is a *value*.
//!
//! While dynamic fields sets may offer a more powerful API, using them in constructors links data for all
//! possible values, i.e. all patterns, that the dynamic field set can represent, even if they are
//! unreachable in code.
//!
//! Static field sets on the other hand leverage the type system to let the compiler drop unneeded data.
//!
//! ### Example
//!
//! ```
//! use icu::datetime::DateTimeFormatter;
//! use icu::datetime::fieldsets::YMD;
//! use icu::datetime::fieldsets::enums::{CompositeFieldSet, DateFieldSet};
//!
//! // This constructor only links data required for YMD
//! let a: DateTimeFormatter<YMD> =
//!     DateTimeFormatter::try_new(Default::default(), YMD::medium()).unwrap();
//!
//! // This constructor links data for *all possible field sets*, even though we only use YMD
//! let b: DateTimeFormatter<CompositeFieldSet> =
//!     DateTimeFormatter::try_new(Default::default(), CompositeFieldSet::Date(DateFieldSet::YMD(YMD::medium()))).unwrap();
//!
//! // If a DateTimeFormatter<CompositeFieldSet> is required, cast after construction instead:
//! let c: DateTimeFormatter<CompositeFieldSet> =  a.cast_into_fset::<CompositeFieldSet>();
//! ```
//!
//! ## Avoid linking unnecessary calendar data
//!
//! All field sets that contain dates use different data for each calendar system when used with [`DateTimeFormatter`].
//! This is good i18n practice, as in general the calendar system should be derived from the user locale,
//! not fixed in code. However, there are legitimate use cases where only one calendar system is supported,
//! in which case [`DateTimeFormatter`] would link unused data. In this case [`FixedCalendarDateTimeFormatter`]
//! can be used, which is generic in a calendar type and only links the data for that calendar.
//!
//! Using [`FixedCalendarDateTimeFormatter`] also avoids linking code that converts inputs to the user's calendar.
//! For field sets that don't contain dates, this can also be achieved using [`NoCalendarFormatter`].

extern crate alloc;

#[cfg(feature = "unstable_chrono_0_4")]
mod chrono;
mod combo;
mod error;
mod external_loaders;
pub mod fieldsets;
mod format;
#[cfg(feature = "unstable_jiff_0_2")]
mod jiff;
mod neo;
pub mod options;
pub mod parts;
pub mod pattern;
pub mod provider;
pub(crate) mod raw;
pub mod scaffold;
pub(crate) mod size_test_macro;
#[cfg(feature = "unstable_time_0_3")]
mod time_crate;
pub mod unchecked;

pub use error::{DateTimeFormatterLoadError, MismatchedCalendarError};

pub use neo::DateTimeFormatter;
pub use neo::DateTimeFormatterPreferences;
pub use neo::FixedCalendarDateTimeFormatter;
pub use neo::FormattedDateTime;
pub use neo::NoCalendarFormatter;

/// Locale preferences used by this crate
pub mod preferences {
    /// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
    #[doc = "\n"] // prevent autoformatting
    pub use icu_locale_core::preferences::extensions::unicode::keywords::CalendarAlgorithm;
    /// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
    #[doc = "\n"] // prevent autoformatting
    pub use icu_locale_core::preferences::extensions::unicode::keywords::HijriCalendarAlgorithm;
    /// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
    #[doc = "\n"] // prevent autoformatting
    pub use icu_locale_core::preferences::extensions::unicode::keywords::HourCycle;
    /// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
    #[doc = "\n"] // prevent autoformatting
    pub use icu_locale_core::preferences::extensions::unicode::keywords::NumberingSystem;
}

/// Types that can be fed to [`DateTimeFormatter`]/[`FixedCalendarDateTimeFormatter`].
///
/// This module contains re-exports from the [`icu_calendar`] and [`icu_time`] crates.
pub mod input {
    #[path = "third_party.rs"]
    pub mod unstable_third_party;

    pub use icu_calendar::Date;
    pub use icu_time::zone::UtcOffset;
    pub use icu_time::DateTime;
    pub use icu_time::Time;
    pub use icu_time::TimeZone;
    pub use icu_time::TimeZoneInfo;
    pub use icu_time::ZonedDateTime;

    #[cfg(feature = "unstable")]
    pub use icu_time::ZonedTime;
}