Struct Date 

pub struct Date(/* private fields */);

Date is a type that represents the MS-DOS date.

This is a packed 16-bit unsigned integer value that specify the date an MS-DOS file was last written to, and is used as timestamps such as FAT or ZIP file format.

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

Implementations

impl Date

pub const MIN: Self

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

This is “1980-01-01”.

Examples

assert_eq!(Date::MIN, Date::from_date(date!(1980-01-01)).unwrap());

pub const MAX: Self

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

This is “2107-12-31”.

Examples

assert_eq!(Date::MAX, Date::from_date(date!(2107-12-31)).unwrap());

impl Date

pub fn new(date: u16) -> Option<Self>

Creates a new Date with the given MS-DOS date.

Returns None if the given MS-DOS date is not a valid MS-DOS date.

Examples

assert_eq!(Date::new(0b0000_0000_0010_0001), Some(Date::MIN));
assert_eq!(Date::new(0b1111_1111_1001_1111), Some(Date::MAX));

// The Day field is 0.
assert_eq!(Date::new(0b0000_0000_0010_0000), None);

pub const unsafe fn new_unchecked(date: u16) -> Self

Creates a new Date with the given MS-DOS date.

Safety

The given MS-DOS date must be a valid MS-DOS date.

Examples

assert_eq!(
    unsafe { Date::new_unchecked(0b0000_0000_0010_0001) },
    Date::MIN
);
assert_eq!(
    unsafe { Date::new_unchecked(0b1111_1111_1001_1111) },
    Date::MAX
);

pub fn from_date(date: Date) -> Result<Self, DateRangeError>

Creates a new Date with the given time::Date.

Errors

Returns Err if date is an invalid as the MS-DOS date.

Examples

assert_eq!(Date::from_date(date!(1980-01-01)), Ok(Date::MIN));
assert_eq!(Date::from_date(date!(2107-12-31)), Ok(Date::MAX));

// Before `1980-01-01`.
assert!(Date::from_date(date!(1979-12-31)).is_err());
// After `2107-12-31`.
assert!(Date::from_date(date!(2108-01-01)).is_err());

pub fn is_valid(self) -> bool

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

Examples

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

// The Day field is 0.
assert_eq!(
    unsafe { Date::new_unchecked(0b0000_0000_0010_0000) }.is_valid(),
    false
);

pub const fn to_raw(self) -> u16

Returns the MS-DOS date of this Date as the underlying u16 value.

Examples

assert_eq!(Date::MIN.to_raw(), 0b0000_0000_0010_0001);
assert_eq!(Date::MAX.to_raw(), 0b1111_1111_1001_1111);

pub const fn year(self) -> u16

Gets the year of this Date.

Examples

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

pub fn month(self) -> Month

Gets the month of this Date.

Examples

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

pub fn day(self) -> u8

Gets the day of this Date.

Examples

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

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Date

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

Formats the value using the given formatter.

impl Default for Date

fn default() -> Self

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

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

Examples

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

impl Display for Date

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

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

Examples

assert_eq!(format!("{}", Date::MIN), "1980-01-01");
assert_eq!(format!("{}", Date::MAX), "2107-12-31");

impl From<Date> for Date

fn from(date: Date) -> Self

Converts a Date to a time::Date.

Examples

assert_eq!(time::Date::from(Date::MIN), date!(1980-01-01));
assert_eq!(time::Date::from(Date::MAX), date!(2107-12-31));

impl From<Date> for Date

Available on crate feature jiff only.

fn from(date: Date) -> Self

Converts a Date to a civil::Date.

Examples

assert_eq!(civil::Date::from(Date::MIN), civil::date(1980, 1, 1));
assert_eq!(civil::Date::from(Date::MAX), civil::date(2107, 12, 31));

impl From<Date> for NaiveDate

Available on crate feature chrono only.

fn from(date: Date) -> Self

Converts a Date to a NaiveDate.

Examples

assert_eq!(
    NaiveDate::from(Date::MIN),
    "1980-01-01".parse::<NaiveDate>().unwrap()
);
assert_eq!(
    NaiveDate::from(Date::MAX),
    "2107-12-31".parse::<NaiveDate>().unwrap()
);

impl Hash for Date

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 Date

fn cmp(&self, other: &Date) -> 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 Date

fn eq(&self, other: &Date) -> 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 Date

fn partial_cmp(&self, other: &Date) -> 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<Date> for Date

fn try_from(date: Date) -> Result<Self, Self::Error>

Converts a time::Date to a Date.

Errors

Returns Err if date is out of range for the MS-DOS date.

Examples

assert_eq!(Date::try_from(date!(1980-01-01)), Ok(Date::MIN));
assert_eq!(Date::try_from(date!(2107-12-31)), Ok(Date::MAX));

// Before `1980-01-01`.
assert!(Date::try_from(date!(1979-12-31)).is_err());
// After `2107-12-31`.
assert!(Date::try_from(date!(2108-01-01)).is_err());

type Error = DateRangeError

The type returned in the event of a conversion error.

impl TryFrom<Date> for Date

Available on crate feature jiff only.

fn try_from(date: Date) -> Result<Self, Self::Error>

Converts a civil::Date to a Date.

Errors

Returns Err if date is out of range for the MS-DOS date.

Examples

assert_eq!(Date::try_from(civil::date(1980, 1, 1)), Ok(Date::MIN));
assert_eq!(Date::try_from(civil::date(2107, 12, 31)), Ok(Date::MAX));

// Before `1980-01-01`.
assert!(Date::try_from(civil::date(1979, 12, 31)).is_err());
// After `2107-12-31`.
assert!(Date::try_from(civil::date(2108, 1, 1)).is_err());

type Error = DateRangeError

The type returned in the event of a conversion error.

impl TryFrom<NaiveDate> for Date

Available on crate feature chrono only.

fn try_from(date: NaiveDate) -> Result<Self, Self::Error>

Converts a NaiveDate to a Date.

Errors

Returns Err if date is out of range for the MS-DOS date.

Examples

assert_eq!(
    Date::try_from("1980-01-01".parse::<NaiveDate>().unwrap()),
    Ok(Date::MIN)
);
assert_eq!(
    Date::try_from("2107-12-31".parse::<NaiveDate>().unwrap()),
    Ok(Date::MAX)
);

// Before `1980-01-01`.
assert!(Date::try_from("1979-12-31".parse::<NaiveDate>().unwrap()).is_err());
// After `2107-12-31`.
assert!(Date::try_from("2108-01-01".parse::<NaiveDate>().unwrap()).is_err());

type Error = DateRangeError

The type returned in the event of a conversion error.

impl Copy for Date

impl Eq for Date

impl StructuralPartialEq for Date