Skip to main content

DateTime

Struct DateTime 

Source
pub struct DateTime<A>
where A: AsCalendar,
{ pub date: Date<A>, pub time: Time, }
Expand description

A date and time for a given calendar.

The primary definition of this type is in the icu_time crate. Other ICU4X crates re-export it for convenience.

This type exists as an input type for datetime formatting and should only be constructed to pass to a datetime formatter.

§Semantics

This type represents the date and time that are displayed to a user. It does not identify the absolute time that an event happens, nor does it represent the general concept of a “local date time”, which would require time zone and leap second information for operations like validation, arithmetic, and comparisons.

Hence, while this type implements PartialEq/Eq (equal DateTimes will display equally), it does not implement PartialOrd/Ord, arithmetic, and it is possible to create DateTimes that do not exist for a particular timezone.

Fields§

§date: Date<A>

The date

§time: Time

The time

Implementations§

Source§

impl<A> DateTime<A>
where A: AsCalendar,

Source

pub fn try_from_str( rfc_9557_str: &str, calendar: A, ) -> Result<DateTime<A>, ParseError>

Creates a DateTime in any calendar from an RFC 9557 string.

Returns an error if the string has a calendar annotation that does not match the calendar argument.

✨ Enabled with the ixdtf Cargo feature.

§Examples
use icu::calendar::cal::Hebrew;
use icu::time::DateTime;

let datetime =
    DateTime::try_from_str("2024-07-17T16:01:17.045[u-ca=hebrew]", Hebrew)
        .unwrap();

assert_eq!(datetime.date.era_year().year, 5784);
assert_eq!(
    datetime.date.month().to_input().code(),
    icu::calendar::types::MonthCode(tinystr::tinystr!(4, "M10"))
);
assert_eq!(datetime.date.day_of_month().0, 11);

assert_eq!(datetime.time.hour.number(), 16);
assert_eq!(datetime.time.minute.number(), 1);
assert_eq!(datetime.time.second.number(), 17);
assert_eq!(datetime.time.subsecond.number(), 45000000);
Source

pub fn try_from_utf8( rfc_9557_str: &[u8], calendar: A, ) -> Result<DateTime<A>, ParseError>

Creates a DateTime in any calendar from an RFC 9557 string.

See Self::try_from_str().

✨ Enabled with the ixdtf Cargo feature.

Trait Implementations§

Source§

impl<A> Clone for DateTime<A>
where A: AsCalendar, Date<A>: Clone,

Source§

fn clone(&self) -> DateTime<A>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C, A> ConvertCalendar for DateTime<A>
where C: IntoAnyCalendar, A: AsCalendar<Calendar = C>,

Source§

type Converted<'a> = DateTime<Ref<'a, AnyCalendar>>

The converted type. This can be the same as the receiver type.
Source§

fn to_calendar<'a>( &self, calendar: &'a AnyCalendar, ) -> <DateTime<A> as ConvertCalendar>::Converted<'a>

Converts self to the specified AnyCalendar.
Source§

impl<A> Copy for DateTime<A>
where A: AsCalendar, Date<A>: Copy,

Source§

impl<A> Debug for DateTime<A>
where A: Debug + AsCalendar,

Source§

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

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

impl<A> Eq for DateTime<A>
where A: AsCalendar, Date<A>: Eq,

Source§

impl FromStr for DateTime<Iso>

Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

fn from_str( rfc_9557_str: &str, ) -> Result<DateTime<Iso>, <DateTime<Iso> as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl<C, A> GetField<()> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self)

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<DayOfMonth> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> DayOfMonth

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<DayOfYear> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> DayOfYear

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<Hour> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> Hour

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<Minute> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> Minute

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<MonthInfo> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> MonthInfo

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<Nanosecond> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> Nanosecond

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<RataDie> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> RataDie

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<Second> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> Second

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<Weekday> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> Weekday

Returns the value of this trait’s field T.
Source§

impl<C, A> GetField<YearInfo> for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Source§

fn get_field(&self) -> YearInfo

Returns the value of this trait’s field T.
Source§

impl<C, A> InFixedCalendar<C> for DateTime<A>
where C: CldrCalendar, A: AsCalendar<Calendar = C>,

Source§

impl<C, A> InSameCalendar for DateTime<A>
where C: IntoAnyCalendar, A: AsCalendar<Calendar = C>,

Source§

fn check_any_calendar_kind( &self, any_calendar_kind: AnyCalendarKind, ) -> Result<(), MismatchedCalendarError>

Checks whether this type is compatible with the given calendar. Read more
Source§

impl<A, B> PartialEq<DateTime<B>> for DateTime<A>
where A: AsCalendar, B: AsCalendar, Date<A>: PartialEq<Date<B>>,

Source§

fn eq(&self, other: &DateTime<B>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<C, A> UnstableSealed for DateTime<A>
where C: Calendar, A: AsCalendar<Calendar = C>,

Auto Trait Implementations§

§

impl<A> Freeze for DateTime<A>
where Date<A>: Freeze,

§

impl<A> RefUnwindSafe for DateTime<A>
where Date<A>: RefUnwindSafe,

§

impl<A> Send for DateTime<A>
where Date<A>: Send,

§

impl<A> Sync for DateTime<A>
where Date<A>: Sync,

§

impl<A> Unpin for DateTime<A>
where Date<A>: Unpin,

§

impl<A> UnsafeUnpin for DateTime<A>
where Date<A>: UnsafeUnpin,

§

impl<A> UnwindSafe for DateTime<A>
where Date<A>: UnwindSafe,

Blanket Implementations§

Source§

impl<T, R> AllInputMarkers<R> for T

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, dest: *mut u8)

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

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GetField<T> for T
where T: Copy + UnstableSealed,

Source§

fn get_field(&self) -> T

Returns the value of this trait’s field T.
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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.