Crate icu_datetime

source ·
Expand description

Formatting date and time.

This module is published as its own crate (icu_datetime) and as part of the icu crate. See the latter for more details on the ICU4X project.

TypedDateTimeFormatter and DateTimeFormatter are the main types of the component. They accepts a set of arguments which allow it to collect necessary data from the data provider, and once instantiated, can be used to quickly format any date and time provided. There are variants of these types that can format greater or fewer components, including TypedDateFormatter & DateFormatter, TypedZonedDateTimeFormatter & ZonedDateTimeFormatter, TimeFormatter, and TimeZoneFormatter

These formatters work with types from the calendar module, like Date, DateTime, and Time, and timezone::CustomTimeZone, however other types may be used provided they implement the traits from the input module.

Each instance of a date-related formatter (i.e. not TimeFormatter or TimeZoneFormatter is associated with a particular Calendar. The “Typed” vs untyped formatter distinction is to help with this. For example, if you know at compile time that you will only be formatting Gregorian dates, you can use TypedDateTimeFormatter<Gregorian> and the APIs will make sure that only Gregorian DateTimes are used with the calendar. On the other hand, if you want to be able to select the calendar at runtime, you can use DateTimeFormatter with the calendar specified in the locale, and use it with DateTime,AnyCalendar. These formatters still require dates associated with the appropriate calendar (though they will convert ISO dates to the calendar if provided), they just do not force the programmer to pick the calendar at compile time.

§Examples

use icu::calendar::{DateTime, Gregorian};
use icu::datetime::{
    options::length, DateTimeFormatter, DateTimeFormatterOptions,
    TypedDateTimeFormatter,
};
use icu::locid::{locale, Locale};
use std::str::FromStr;
use writeable::assert_writeable_eq;

// See the next code example for a more ergonomic example with .into().
let options =
    DateTimeFormatterOptions::Length(length::Bag::from_date_time_style(
        length::Date::Medium,
        length::Time::Short,
    ));

// You can work with a formatter that can select the calendar at runtime:
let locale = Locale::from_str("en-u-ca-gregory").unwrap();
let dtf = DateTimeFormatter::try_new(&locale.into(), options.clone())
    .expect("Failed to create DateTimeFormatter instance.");

// Or one that selects a calendar at compile time:
let typed_dtf = TypedDateTimeFormatter::<Gregorian>::try_new(
    &locale!("en").into(),
    options,
)
.expect("Failed to create TypedDateTimeFormatter instance.");

let typed_date =
    DateTime::try_new_gregorian_datetime(2020, 9, 12, 12, 34, 28).unwrap();
// prefer using ISO dates with DateTimeFormatter
let date = typed_date.to_iso().to_any();

let formatted_date = dtf.format(&date).expect("Calendars should match");
let typed_formatted_date = typed_dtf.format(&typed_date);

assert_writeable_eq!(formatted_date, "Sep 12, 2020, 12:34 PM");
assert_writeable_eq!(typed_formatted_date, "Sep 12, 2020, 12:34 PM");

let formatted_date_string =
    dtf.format_to_string(&date).expect("Calendars should match");
let typed_formatted_date_string = typed_dtf.format_to_string(&typed_date);

assert_eq!(formatted_date_string, "Sep 12, 2020, 12:34 PM");
assert_eq!(typed_formatted_date_string, "Sep 12, 2020, 12:34 PM");

The options can be created more ergonomically using the Into trait to automatically convert a options::length::Bag into a DateTimeFormatterOptions::Length.

use icu::calendar::Gregorian;
use icu::datetime::{
    options::length, DateTimeFormatterOptions, TypedDateTimeFormatter,
};
use icu::locid::locale;
let options = length::Bag::from_date_time_style(
    length::Date::Medium,
    length::Time::Short,
)
.into();

let dtf = TypedDateTimeFormatter::<Gregorian>::try_new(
    &locale!("en").into(),
    options,
);

At the moment, the crate provides only options using the Length bag, but in the future, we expect to add more ways to customize the output, like skeletons, and components.

Re-exports§

Modules§

  • any 🔒
    This module contains the untyped AnyCalendar-based TypedDateTimeFormatter APIs that are capable of formatting dates from any calendar
  • calendar 🔒
  • datetime 🔒
    The collection of code that is needed for handling formatting operations for DateTimes. Central to this is the TypedDateTimeFormatter.
  • error 🔒
  • fields
    Enums representing the fields in a date pattern, including the field’s type, length and symbol.
  • format 🔒
  • helpers 🔒
  • input
    A collection of utilities for representing and working with dates as an input to formatting operations.
  • options
    DateTimeFormatterOptions is a bag of options which, together with Locale, defines how dates will be formatted with a TypedDateTimeFormatter instance.
  • provider
    🚧 [Unstable] Data provider struct definitions for this ICU4X component.
  • raw 🔒
  • time_zone
    A formatter specifically for the time zone.
  • zoned_datetime 🔒

Structs§

Enums§

  • DateTimeError
    A list of error outcomes for various operations in this module.

Traits§