Struct hoi4save::Date

pub struct Date { /* fields omitted */ }

Struct specialized to parsing, formatting, and manipulating dates in games

A game date does not follow any traditional calendar and instead views the world on simpler terms: that every year should be treated as a non-leap year.

Implementations

impl Date

pub fn new(year: i16, month: u8, day: u8, hour: u8) -> Option<Self>

pub fn year(&self) -> i16

Year of the date

pub fn month(&self) -> u8

Month of the date

pub fn day(&self) -> u8

Day of the date

pub fn hour(&self) -> u8

Day of the date

pub fn parse_from_str<T: AsRef<str>>(s: T) -> Option<Self>

Parses a string and returns a new Date if valid.

pub fn days_until(&self, other: &Date) -> i32

Returns the number of days between two dates

pub fn add_days(&self, days: i32) -> Date

Return a new date that is the given number of days in the future from the current date

Will panic on overflow or underflow.

pub fn from_binary(s: i32) -> Option<Self>

Decodes a date from a number that had been parsed from binary data

pub fn iso_8601(&self) -> String

Formats a date in the ISO 8601 format: YYYY-MM-DD

pub fn game_fmt(&self) -> String

Formats a date in the game format: Y.M.D

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a copy 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<'de> Deserialize<'de> for Date

fn deserialize<D>(deserializer: D) -> Result<Date, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Ord for Date

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Date> for Date

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

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

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

This method tests for !=.

impl PartialOrd<Date> for Date

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl Serialize for Date

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

Serialize this value into the given Serde serializer.

impl Copy for Date

impl Eq for Date

impl StructuralEq for Date

impl StructuralPartialEq for Date