[go: up one dir, main page]

Struct time::PrimitiveDateTime[−][src]

pub struct PrimitiveDateTime { /* fields omitted */ }
Expand description

Combined date and time.

Implementations

impl PrimitiveDateTime[src]

pub const fn new(date: Date, time: Time) -> Self[src]

Create a new PrimitiveDateTime from the provided Date and Time.

assert_eq!(
    PrimitiveDateTime::new(date!("2019-01-01"), time!("0:00")),
    datetime!("2019-01-01 0:00"),
);
Run

pub const fn date(self) -> Date[src]

Get the Date component of the PrimitiveDateTime.

assert_eq!(datetime!("2019-01-01 0:00").date(), date!("2019-01-01"));
Run

pub const fn time(self) -> Time[src]

Get the Time component of the PrimitiveDateTime.

assert_eq!(datetime!("2019-01-01 0:00").time(), time!("0:00"));
Run

pub const fn year(self) -> i32[src]

Get the year of the date.

assert_eq!(datetime!("2019-01-01 0:00").year(), 2019);
assert_eq!(datetime!("2019-12-31 0:00").year(), 2019);
assert_eq!(datetime!("2020-01-01 0:00").year(), 2020);
Run

pub const fn month(self) -> Month[src]

Get the month of the date.

The returned value will always be in the range 1..=12.

assert_eq!(datetime!("2019-01-01 0:00").month(), Month::January);
assert_eq!(datetime!("2019-12-31 0:00").month(), Month::December);
Run

pub const fn day(self) -> u8[src]

Get the day of the date.

The returned value will always be in the range 1..=31.

assert_eq!(datetime!("2019-01-01 0:00").day(), 1);
assert_eq!(datetime!("2019-12-31 0:00").day(), 31);
Run

pub const fn ordinal(self) -> u16[src]

Get the day of the year.

The returned value will always be in the range 1..=366 (1..=365 for common years).

assert_eq!(datetime!("2019-01-01 0:00").ordinal(), 1);
assert_eq!(datetime!("2019-12-31 0:00").ordinal(), 365);
Run

pub const fn iso_week(self) -> u8[src]

Get the ISO week number.

The returned value will always be in the range 1..=53.

assert_eq!(datetime!("2019-01-01 0:00").iso_week(), 1);
assert_eq!(datetime!("2019-10-04 0:00").iso_week(), 40);
assert_eq!(datetime!("2020-01-01 0:00").iso_week(), 1);
assert_eq!(datetime!("2020-12-31 0:00").iso_week(), 53);
assert_eq!(datetime!("2021-01-01 0:00").iso_week(), 53);
Run

pub const fn sunday_based_week(self) -> u8[src]

Get the week number where week 1 begins on the first Sunday.

The returned value will always be in the range 0..=53.

assert_eq!(datetime!("2019-01-01 0:00").sunday_based_week(), 0);
assert_eq!(datetime!("2020-01-01 0:00").sunday_based_week(), 0);
assert_eq!(datetime!("2020-12-31 0:00").sunday_based_week(), 52);
assert_eq!(datetime!("2021-01-01 0:00").sunday_based_week(), 0);
Run

pub const fn monday_based_week(self) -> u8[src]

Get the week number where week 1 begins on the first Monday.

The returned value will always be in the range 0..=53.

assert_eq!(datetime!("2019-01-01 0:00").monday_based_week(), 0);
assert_eq!(datetime!("2020-01-01 0:00").monday_based_week(), 0);
assert_eq!(datetime!("2020-12-31 0:00").monday_based_week(), 52);
assert_eq!(datetime!("2021-01-01 0:00").monday_based_week(), 0);
Run

pub const fn to_calendar_date(self) -> (i32, Month, u8)[src]

Get the year, month, and day.

assert_eq!(
    datetime!("2019-01-01 0:00").to_calendar_date(),
    (2019, Month::January, 1)
);
Run

pub const fn to_ordinal_date(self) -> (i32, u16)[src]

Get the year and ordinal day number.

assert_eq!(datetime!("2019-01-01 0:00").to_ordinal_date(), (2019, 1));
Run

pub const fn to_iso_week_date(self) -> (i32, u8, Weekday)[src]

Get the ISO 8601 year, week number, and weekday.

assert_eq!(
    datetime!("2019-01-01 0:00").to_iso_week_date(),
    (2019, 1, Tuesday)
);
assert_eq!(
    datetime!("2019-10-04 0:00").to_iso_week_date(),
    (2019, 40, Friday)
);
assert_eq!(
    datetime!("2020-01-01 0:00").to_iso_week_date(),
    (2020, 1, Wednesday)
);
assert_eq!(
    datetime!("2020-12-31 0:00").to_iso_week_date(),
    (2020, 53, Thursday)
);
assert_eq!(
    datetime!("2021-01-01 0:00").to_iso_week_date(),
    (2020, 53, Friday)
);
Run

pub const fn weekday(self) -> Weekday[src]

Get the weekday.

assert_eq!(datetime!("2019-01-01 0:00").weekday(), Tuesday);
assert_eq!(datetime!("2019-02-01 0:00").weekday(), Friday);
assert_eq!(datetime!("2019-03-01 0:00").weekday(), Friday);
assert_eq!(datetime!("2019-04-01 0:00").weekday(), Monday);
assert_eq!(datetime!("2019-05-01 0:00").weekday(), Wednesday);
assert_eq!(datetime!("2019-06-01 0:00").weekday(), Saturday);
assert_eq!(datetime!("2019-07-01 0:00").weekday(), Monday);
assert_eq!(datetime!("2019-08-01 0:00").weekday(), Thursday);
assert_eq!(datetime!("2019-09-01 0:00").weekday(), Sunday);
assert_eq!(datetime!("2019-10-01 0:00").weekday(), Tuesday);
assert_eq!(datetime!("2019-11-01 0:00").weekday(), Friday);
assert_eq!(datetime!("2019-12-01 0:00").weekday(), Sunday);
Run

pub const fn to_julian_day(self) -> i32[src]

Get the Julian day for the date. The time is not taken into account for this calculation.

The algorithm to perform this conversion is derived from one provided by Peter Baum; it is freely available here.

assert_eq!(datetime!("-4713-11-24 0:00").to_julian_day(), 0);
assert_eq!(datetime!("2000-01-01 0:00").to_julian_day(), 2_451_545);
assert_eq!(datetime!("2019-01-01 0:00").to_julian_day(), 2_458_485);
assert_eq!(datetime!("2019-12-31 0:00").to_julian_day(), 2_458_849);
Run

pub const fn as_hms(self) -> (u8, u8, u8)[src]

Get the clock hour, minute, and second.

assert_eq!(datetime!("2020-01-01 0:00:00").as_hms(), (0, 0, 0));
assert_eq!(datetime!("2020-01-01 23:59:59").as_hms(), (23, 59, 59));
Run

pub const fn as_hms_milli(self) -> (u8, u8, u8, u16)[src]

Get the clock hour, minute, second, and millisecond.

assert_eq!(datetime!("2020-01-01 0:00:00").as_hms_milli(), (0, 0, 0, 0));
assert_eq!(
    datetime!("2020-01-01 23:59:59.999").as_hms_milli(),
    (23, 59, 59, 999)
);
Run

pub const fn as_hms_micro(self) -> (u8, u8, u8, u32)[src]

Get the clock hour, minute, second, and microsecond.

assert_eq!(datetime!("2020-01-01 0:00:00").as_hms_micro(), (0, 0, 0, 0));
assert_eq!(
    datetime!("2020-01-01 23:59:59.999_999").as_hms_micro(),
    (23, 59, 59, 999_999)
);
Run

pub const fn as_hms_nano(self) -> (u8, u8, u8, u32)[src]

Get the clock hour, minute, second, and nanosecond.

assert_eq!(datetime!("2020-01-01 0:00:00").as_hms_nano(), (0, 0, 0, 0));
assert_eq!(
    datetime!("2020-01-01 23:59:59.999_999_999").as_hms_nano(),
    (23, 59, 59, 999_999_999)
);
Run

pub const fn hour(self) -> u8[src]

Get the clock hour.

The returned value will always be in the range 0..24.

assert_eq!(datetime!("2019-01-01 0:00").hour(), 0);
assert_eq!(datetime!("2019-01-01 23:59:59").hour(), 23);
Run

pub const fn minute(self) -> u8[src]

Get the minute within the hour.

The returned value will always be in the range 0..60.

assert_eq!(datetime!("2019-01-01 0:00").minute(), 0);
assert_eq!(datetime!("2019-01-01 23:59:59").minute(), 59);
Run

pub const fn second(self) -> u8[src]

Get the second within the minute.

The returned value will always be in the range 0..60.

assert_eq!(datetime!("2019-01-01 0:00").second(), 0);
assert_eq!(datetime!("2019-01-01 23:59:59").second(), 59);
Run

pub const fn millisecond(self) -> u16[src]

Get the milliseconds within the second.

The returned value will always be in the range 0..1_000.

assert_eq!(datetime!("2019-01-01 0:00").millisecond(), 0);
assert_eq!(datetime!("2019-01-01 23:59:59.999").millisecond(), 999);
Run

pub const fn microsecond(self) -> u32[src]

Get the microseconds within the second.

The returned value will always be in the range 0..1_000_000.

assert_eq!(datetime!("2019-01-01 0:00").microsecond(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59.999_999").microsecond(),
    999_999
);
Run

pub const fn nanosecond(self) -> u32[src]

Get the nanoseconds within the second.

The returned value will always be in the range 0..1_000_000_000.

assert_eq!(datetime!("2019-01-01 0:00").nanosecond(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59.999_999_999").nanosecond(),
    999_999_999,
);
Run

pub const fn assume_offset(self, offset: UtcOffset) -> OffsetDateTime[src]

Assuming that the existing PrimitiveDateTime represents a moment in the provided UtcOffset, return an OffsetDateTime.

assert_eq!(
    datetime!("2019-01-01 0:00")
        .assume_offset(offset!("UTC"))
        .unix_timestamp(),
    1_546_300_800,
);
assert_eq!(
    datetime!("2019-01-01 0:00")
        .assume_offset(offset!("-1"))
        .unix_timestamp(),
    1_546_304_400,
);
Run

pub const fn assume_utc(self) -> OffsetDateTime[src]

Assuming that the existing PrimitiveDateTime represents a moment in the UTC, return an OffsetDateTime.

assert_eq!(
    datetime!("2019-01-01 0:00").assume_utc().unix_timestamp(),
    1_546_300_800,
);
Run

impl PrimitiveDateTime[src]

Methods that replace part of the PrimitiveDateTime.

#[must_use = "This method does not mutate the original `PrimitiveDateTime`."]
pub const fn replace_time(self, time: Time) -> Self[src]

Replace the time, preserving the date.

assert_eq!(
    datetime!("2020-01-01 17:00").replace_time(time!("5:00")),
    datetime!("2020-01-01 5:00")
);
Run

#[must_use = "This method does not mutate the original `PrimitiveDateTime`."]
pub const fn replace_date(self, date: Date) -> Self[src]

Replace the date, preserving the time.

assert_eq!(
    datetime!("2020-01-01 12:00").replace_date(date!("2020-01-30")),
    datetime!("2020-01-30 12:00")
);
Run

impl PrimitiveDateTime[src]

pub fn format_into(
    self,
    output: &mut impl Write,
    format: &impl Formattable
) -> Result<usize, Format>[src]

This is supported on crate feature formatting only.

Format the PrimitiveDateTime using the provided format description. The formatted value will be output to the provided writer. The format description will typically be parsed by using format_description::parse.

pub fn format(self, format: &impl Formattable) -> Result<String, Format>[src]

This is supported on crate feature formatting only.

Format the PrimitiveDateTime using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[year]-[month]-[day] [hour]:[minute]:[second]")?;
assert_eq!(
    datetime!("2020-01-02 03:04:05").format(&format)?,
    "2020-01-02 03:04:05"
);
Run

impl PrimitiveDateTime[src]

pub fn parse(input: &str, description: &impl Parsable) -> Result<Self, Parse>[src]

This is supported on crate feature parsing only.

Parse a PrimitiveDateTime from the input using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[year]-[month]-[day] [hour]:[minute]:[second]")?;
assert_eq!(
    PrimitiveDateTime::parse("2020-01-02 03:04:05", &format)?,
    datetime!("2020-01-02 03:04:05")
);
Run

Trait Implementations

impl Add<Duration> for PrimitiveDateTime[src]

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: Duration) -> Self::Output[src]

Performs the + operation. Read more

impl Add<Duration> for PrimitiveDateTime[src]

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: StdDuration) -> Self::Output[src]

Performs the + operation. Read more

impl<T> AddAssign<T> for PrimitiveDateTime where
    Self: Add<T, Output = Self>, [src]

fn add_assign(&mut self, rhs: T)[src]

Performs the += operation. Read more

impl Arbitrary for PrimitiveDateTime[src]

This is supported on crate feature quickcheck only.

fn arbitrary(g: &mut Gen) -> Self[src]

Return an arbitrary value. Read more

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>[src]

Return an iterator of values that are smaller than itself. Read more

impl Clone for PrimitiveDateTime[src]

fn clone(&self) -> PrimitiveDateTime[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for PrimitiveDateTime[src]

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

Formats the value using the given formatter. Read more

impl<'a> Deserialize<'a> for PrimitiveDateTime[src]

This is supported on crate feature serde only.

fn deserialize<D: Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error>[src]

Deserialize this value from the given Serde deserializer. Read more

impl Display for PrimitiveDateTime[src]

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

Formats the value using the given formatter. Read more

impl Hash for PrimitiveDateTime[src]

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

Feeds this value into the given Hasher. Read more

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

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

impl Ord for PrimitiveDateTime[src]

fn cmp(&self, other: &PrimitiveDateTime) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self1.50.0[src]

Restrict a value to a certain interval. Read more

impl PartialEq<PrimitiveDateTime> for PrimitiveDateTime[src]

fn eq(&self, other: &PrimitiveDateTime) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &PrimitiveDateTime) -> bool[src]

This method tests for !=.

impl PartialOrd<PrimitiveDateTime> for PrimitiveDateTime[src]

fn partial_cmp(&self, other: &PrimitiveDateTime) -> Option<Ordering>[src]

This method returns an ordering between self and other values if one exists. Read more

#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src]

This method tests less than (for self and other) and is used by the < operator. Read more

#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

#[must_use]
fn gt(&self, other: &Rhs) -> bool1.0.0[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Serialize for PrimitiveDateTime[src]

This is supported on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>[src]

Serialize this value into the given Serde serializer. Read more

impl Sub<Duration> for PrimitiveDateTime[src]

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: Duration) -> Self::Output[src]

Performs the - operation. Read more

impl Sub<Duration> for PrimitiveDateTime[src]

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: StdDuration) -> Self::Output[src]

Performs the - operation. Read more

impl Sub<PrimitiveDateTime> for PrimitiveDateTime[src]

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output[src]

Performs the - operation. Read more

impl<T> SubAssign<T> for PrimitiveDateTime where
    Self: Sub<T, Output = Self>, [src]

fn sub_assign(&mut self, rhs: T)[src]

Performs the -= operation. Read more

impl TryFrom<Parsed> for PrimitiveDateTime[src]

This is supported on crate feature parsing only.

type Error = TryFromParsed

The type returned in the event of a conversion error.

fn try_from(parsed: Parsed) -> Result<Self, Self::Error>[src]

Performs the conversion.

impl Copy for PrimitiveDateTime[src]

impl Eq for PrimitiveDateTime[src]

impl StructuralEq for PrimitiveDateTime[src]

impl StructuralPartialEq for PrimitiveDateTime[src]

Auto Trait Implementations

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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