Struct DateTime 

pub struct DateTime { /* private fields */ }

DateTime is a type that combines a Date and a Time and represents MS-DOS date and time.

These are packed 16-bit unsigned integer values that specify the date and time an MS-DOS file was last written to, and are used as timestamps such as FAT or ZIP file format.

The resolution of MS-DOS date and time is 2 seconds.

See the format specification for Kaitai Struct for more details on the structure of MS-DOS date and time.

Implementations

impl DateTime

pub const MIN: Self

The smallest value that can be represented by MS-DOS date and time.

This is “1980-01-01 00:00:00”.

Examples

assert_eq!(
    DateTime::MIN,
    DateTime::from_date_time(date!(1980-01-01), Time::MIDNIGHT).unwrap()
);

pub const MAX: Self

The largest value that can be represented by MS-DOS date and time.

This is “2107-12-31 23:59:58”.

Examples

assert_eq!(
    DateTime::MAX,
    DateTime::from_date_time(date!(2107-12-31), time!(23:59:58)).unwrap()
);

impl DateTime

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

Creates a new DateTime with the given Date and Time.

Examples

assert_eq!(DateTime::new(Date::MIN, Time::MIN), DateTime::MIN);
assert_eq!(DateTime::new(Date::MAX, Time::MAX), DateTime::MAX);

pub fn from_date_time( date: Date, time: Time, ) -> Result<Self, DateTimeRangeError>

Creates a new DateTime with the given time::Date and time::Time.

The resolution of MS-DOS date and time is 2 seconds. So this method rounds towards zero, truncating any fractional part of the exact result of dividing seconds by 2.

Errors

Returns Err if date or time are invalid as MS-DOS date and time.

Examples

assert_eq!(
    DateTime::from_date_time(date!(1980-01-01), Time::MIDNIGHT),
    Ok(DateTime::MIN)
);
assert_eq!(
    DateTime::from_date_time(date!(2107-12-31), time!(23:59:58)),
    Ok(DateTime::MAX)
);

// Before `1980-01-01 00:00:00`.
assert!(DateTime::from_date_time(date!(1979-12-31), time!(23:59:59)).is_err());
// After `2107-12-31 23:59:59`.
assert!(DateTime::from_date_time(date!(2108-01-01), Time::MIDNIGHT).is_err());

pub fn is_valid(self) -> bool

Returns true if self is valid MS-DOS date and time, and false otherwise.

Examples

assert_eq!(DateTime::MIN.is_valid(), true);
assert_eq!(DateTime::MAX.is_valid(), true);

assert_eq!(
    DateTime::new(unsafe { Date::new_unchecked(u16::MAX) }, unsafe {
        Time::new_unchecked(u16::MAX)
    })
    .is_valid(),
    false
);

pub const fn date(self) -> Date

Gets the Date of this DateTime.

Examples

assert_eq!(DateTime::MIN.date(), Date::MIN);
assert_eq!(DateTime::MAX.date(), Date::MAX);

pub const fn time(self) -> Time

Gets the Time of this DateTime.

Examples

assert_eq!(DateTime::MIN.time(), Time::MIN);
assert_eq!(DateTime::MAX.time(), Time::MAX);

pub const fn year(self) -> u16

Gets the year of this DateTime.

Examples

assert_eq!(DateTime::MIN.year(), 1980);
assert_eq!(DateTime::MAX.year(), 2107);

pub fn month(self) -> Month

Gets the month of this DateTime.

Examples

assert_eq!(DateTime::MIN.month(), Month::January);
assert_eq!(DateTime::MAX.month(), Month::December);

pub fn day(self) -> u8

Gets the day of this DateTime.

Examples

assert_eq!(DateTime::MIN.day(), 1);
assert_eq!(DateTime::MAX.day(), 31);

pub fn hour(self) -> u8

Gets the hour of this DateTime.

Examples

assert_eq!(DateTime::MIN.hour(), 0);
assert_eq!(DateTime::MAX.hour(), 23);

pub fn minute(self) -> u8

Gets the minute of this DateTime.

Examples

assert_eq!(DateTime::MIN.minute(), 0);
assert_eq!(DateTime::MAX.minute(), 59);

pub fn second(self) -> u8

Gets the second of this DateTime.

Examples

assert_eq!(DateTime::MIN.second(), 0);
assert_eq!(DateTime::MAX.second(), 58);

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DateTime

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

Formats the value using the given formatter.

impl Default for DateTime

fn default() -> Self

Returns the default value of “1980-01-01 00:00:00”.

Equivalent to DateTime::MIN except that it is not callable in const contexts.

Examples

assert_eq!(DateTime::default(), DateTime::MIN);

impl Display for DateTime

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

Shows the value of this DateTime in the well-known RFC 3339 format.

Examples

assert_eq!(format!("{}", DateTime::MIN), "1980-01-01 00:00:00");
assert_eq!(format!("{}", DateTime::MAX), "2107-12-31 23:59:58");

impl From<DateTime> for DateTime

Available on crate feature jiff only.

fn from(dt: DateTime) -> Self

Converts a DateTime to a civil::DateTime.

Examples

assert_eq!(
    civil::DateTime::from(DateTime::MIN),
    civil::date(1980, 1, 1).at(0, 0, 0, 0)
);
assert_eq!(
    civil::DateTime::from(DateTime::MAX),
    civil::date(2107, 12, 31).at(23, 59, 58, 0)
);

impl From<DateTime> for NaiveDateTime

Available on crate feature chrono only.

fn from(dt: DateTime) -> Self

Converts a DateTime to a NaiveDateTime.

Examples

assert_eq!(
    NaiveDateTime::from(DateTime::MIN),
    "1980-01-01T00:00:00".parse::<NaiveDateTime>().unwrap()
);
assert_eq!(
    NaiveDateTime::from(DateTime::MAX),
    "2107-12-31T23:59:58".parse::<NaiveDateTime>().unwrap()
);

impl From<DateTime> for PrimitiveDateTime

fn from(dt: DateTime) -> Self

Converts a DateTime to a PrimitiveDateTime.

Examples

assert_eq!(
    PrimitiveDateTime::from(DateTime::MIN),
    datetime!(1980-01-01 00:00:00)
);
assert_eq!(
    PrimitiveDateTime::from(DateTime::MAX),
    datetime!(2107-12-31 23:59:58)
);

impl Hash for DateTime

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DateTime

fn cmp(&self, other: &DateTime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DateTime

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DateTime

fn partial_cmp(&self, other: &DateTime) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<DateTime> for DateTime

Available on crate feature jiff only.

fn try_from(dt: DateTime) -> Result<Self, Self::Error>

Converts a civil::DateTime to a DateTime.

The resolution of MS-DOS date and time is 2 seconds. So this method rounds towards zero, truncating any fractional part of the exact result of dividing seconds by 2.

Errors

Returns Err if dt is out of range for MS-DOS date and time.

Examples

assert_eq!(
    DateTime::try_from(civil::date(1980, 1, 1).at(0, 0, 0, 0)),
    Ok(DateTime::MIN)
);
assert_eq!(
    DateTime::try_from(civil::date(2107, 12, 31).at(23, 59, 58, 0)),
    Ok(DateTime::MAX)
);

// Before `1980-01-01 00:00:00`.
assert!(DateTime::try_from(civil::date(1979, 12, 31).at(23, 59, 59, 0)).is_err());
// After `2107-12-31 23:59:59`.
assert!(DateTime::try_from(civil::date(2108, 1, 1).at(0, 0, 0, 0)).is_err());

type Error = DateTimeRangeError

The type returned in the event of a conversion error.

impl TryFrom<NaiveDateTime> for DateTime

Available on crate feature chrono only.

fn try_from(dt: NaiveDateTime) -> Result<Self, Self::Error>

Converts a NaiveDateTime to a DateTime.

The resolution of MS-DOS date and time is 2 seconds. So this method rounds towards zero, truncating any fractional part of the exact result of dividing seconds by 2.

Errors

Returns Err if dt is out of range for MS-DOS date and time.

Examples

assert_eq!(
    DateTime::try_from("1980-01-01T00:00:00".parse::<NaiveDateTime>().unwrap()),
    Ok(DateTime::MIN)
);
assert_eq!(
    DateTime::try_from("2107-12-31T23:59:58".parse::<NaiveDateTime>().unwrap()),
    Ok(DateTime::MAX)
);

// Before `1980-01-01 00:00:00`.
assert!(DateTime::try_from("1979-12-31T23:59:59".parse::<NaiveDateTime>().unwrap()).is_err());
// After `2107-12-31 23:59:59`.
assert!(DateTime::try_from("2108-01-01T00:00:00".parse::<NaiveDateTime>().unwrap()).is_err());

type Error = DateTimeRangeError

The type returned in the event of a conversion error.

impl TryFrom<PrimitiveDateTime> for DateTime

fn try_from(dt: PrimitiveDateTime) -> Result<Self, Self::Error>

Converts a PrimitiveDateTime to a DateTime.

The resolution of MS-DOS date and time is 2 seconds. So this method rounds towards zero, truncating any fractional part of the exact result of dividing seconds by 2.

Errors

Returns Err if dt is out of range for MS-DOS date and time.

Examples

assert_eq!(
    DateTime::try_from(datetime!(1980-01-01 00:00:00)),
    Ok(DateTime::MIN)
);
assert_eq!(
    DateTime::try_from(datetime!(2107-12-31 23:59:58)),
    Ok(DateTime::MAX)
);

// Before `1980-01-01 00:00:00`.
assert!(DateTime::try_from(datetime!(1979-12-31 23:59:59)).is_err());
// After `2107-12-31 23:59:59`.
assert!(DateTime::try_from(datetime!(2108-01-01 00:00:00)).is_err());

type Error = DateTimeRangeError

The type returned in the event of a conversion error.

impl Copy for DateTime

impl Eq for DateTime

impl StructuralPartialEq for DateTime