Enum icu_datetime::options::TimePrecision

source ·
#[non_exhaustive]
pub enum TimePrecision { HourPlus, HourExact, MinutePlus, MinuteExact, SecondPlus, SecondExact(FractionalSecondDigits), }
Expand description

A specification for how precisely to display the time of day.

The time can be displayed with hour, minute, or second precision, and zero-valued fields can be automatically hidden.

The examples in the discriminants are based on the following inputs and hour cycles:

  1. 11 o’clock with 12-hour time
  2. 16:20 (4:20 pm) with 24-hour time
  3. 7:15:01.85 with 24-hour time

§Examples

use icu::calendar::Time;
use icu::datetime::fieldsets::T;
use icu::datetime::options::FractionalSecondDigits;
use icu::datetime::options::TimePrecision;
use icu::datetime::FixedCalendarDateTimeFormatter;
use icu::locale::locale;
use writeable::assert_writeable_eq;

let formatters = [
    TimePrecision::HourPlus,
    TimePrecision::HourExact,
    TimePrecision::MinutePlus,
    TimePrecision::MinuteExact,
    TimePrecision::SecondPlus,
    TimePrecision::SecondExact(FractionalSecondDigits::F0),
]
.map(|time_precision| {
    FixedCalendarDateTimeFormatter::<(), _>::try_new(
        locale!("en-US").into(),
        T::short().with_time_precision(time_precision),
    )
    .unwrap()
});

let times = [
    Time::try_new(7, 0, 0, 0).unwrap(),
    Time::try_new(7, 0, 10, 0).unwrap(),
    Time::try_new(7, 12, 20, 5).unwrap(),
];

// TODO(#5782): the Plus variants should render fractional digits
let expected_value_table = [
    // 7:00:00, 7:00:10, 7:12:20.5432
    ["7 AM", "7:00:10 AM", "7:12:20 AM"], // HourPlus
    ["7 AM", "7 AM", "7 AM"],             // HourExact
    ["7:00 AM", "7:00:10 AM", "7:12:20 AM"], // MinutePlus
    ["7:00 AM", "7:00 AM", "7:12 AM"],    // MinuteExact
    ["7:00:00 AM", "7:00:10 AM", "7:12:20 AM"], // SecondPlus
    ["7:00:00 AM", "7:00:10 AM", "7:12:20 AM"], // SecondExact
];

for (expected_value_row, formatter) in
    expected_value_table.iter().zip(formatters.iter())
{
    for (expected_value, time) in
        expected_value_row.iter().zip(times.iter())
    {
        assert_writeable_eq!(
            formatter.format(time),
            *expected_value,
            "{formatter:?} @ {time:?}"
        );
    }
}

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

HourPlus

Always display the hour. Display smaller fields if they are nonzero.

Examples:

  1. 11 am
  2. 16:20
  3. 07:15:01.85
§

HourExact

Always display the hour. Hide all other time fields.

Examples:

  1. 11 am
  2. 16h
  3. 07h
§

MinutePlus

Always display the hour and minute. Display the second if nonzero.

Examples:

  1. 11:00 am
  2. 16:20
  3. 07:15:01.85
§

MinuteExact

Always display the hour and minute. Hide the second.

Examples:

  1. 11:00 am
  2. 16:20
  3. 07:15
§

SecondPlus

Display the hour, minute, and second. Display fractional seconds if nonzero.

This is the default.

Examples:

  1. 11:00:00 am
  2. 16:20:00
  3. 07:15:01.85
§

SecondExact(FractionalSecondDigits)

Display the hour, minute, and second with the given number of fractional second digits.

Examples with FractionalSecondDigits::F1:

  1. 11:00:00.0 am
  2. 16:20:00.0
  3. 07:15:01.8

Trait Implementations§

source§

impl Clone for TimePrecision

source§

fn clone(&self) -> TimePrecision

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for TimePrecision

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for TimePrecision

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Hash for TimePrecision

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl IntoOption<TimePrecision> for TimePrecision

source§

fn into_option(self) -> Option<Self>

Return self as an Option<T>
source§

impl PartialEq for TimePrecision

source§

fn eq(&self, other: &TimePrecision) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for TimePrecision

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for TimePrecision

source§

impl Eq for TimePrecision

source§

impl StructuralPartialEq for TimePrecision

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,