Struct jomini::common::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: u16, month: u8, day: u8) -> Option<Self>

Create a new date from year, month, and day parts

Will return None if the date does not exist

use jomini::common::Date;
assert_eq!(Date::new(1444, 11, 11), Date::parse_from_str("1444.11.11"));
assert_eq!(Date::new(800, 5, 3), Date::parse_from_str("800.5.3"));
assert!(Date::new(800, 0, 3).is_none());
assert!(Date::new(800, 1, 0).is_none());
assert!(Date::new(800, 13, 1).is_none());
assert!(Date::new(800, 12, 32).is_none());
assert!(Date::new(2020, 2, 29).is_none());

pub fn year(&self) -> u16

Year of the date

use jomini::common::Date;
let date = Date::parse_from_str("1445.02.03").expect("to parse date");
assert_eq!(date.year(), 1445);

pub fn month(&self) -> u8

Month of the date

use jomini::common::Date;
let date = Date::parse_from_str("1445.02.03").expect("to parse date");
assert_eq!(date.month(), 2);

pub fn day(&self) -> u8

Day of the date

use jomini::common::Date;
let date = Date::parse_from_str("1445.02.03").expect("to parse date");
assert_eq!(date.day(), 3);

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

Parses a string and returns a new Date if valid.

use jomini::common::Date;
let date = Date::parse_from_str("1444.11.11").expect("to parse date");
assert_eq!(date.year(), 1444);
assert_eq!(date.month(), 11);
assert_eq!(date.day(), 11);

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

Returns the number of days between two dates

use jomini::common::Date;
let date = Date::parse_from_str("1400.1.2").unwrap();
let date2 = Date::parse_from_str("1400.1.3").unwrap();
let date3 = Date::parse_from_str("1401.1.2").unwrap();
let date4 = Date::parse_from_str("1401.12.31").unwrap();
assert_eq!(1, date.days_until(&date2));
assert_eq!(365, date.days_until(&date3));
assert_eq!(728, date.days_until(&date4));
assert_eq!(-728, date4.days_until(&date));

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

use jomini::common::Date;

let date = Date::parse_from_str("1400.1.2").unwrap();
let expected = Date::parse_from_str("1400.1.3").unwrap();
let expected2 = Date::parse_from_str("1400.1.1").unwrap();
assert_eq!(expected, date.add_days(1));
assert_eq!(expected2, date.add_days(-1));

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

use jomini::common::Date;
let date = Date::parse_from_str("1400.1.2").expect("to parse date");
assert_eq!(date.iso_8601(), String::from("1400-01-02"));

pub fn game_fmt(&self) -> String

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

use jomini::common::Date;
let date = Date::parse_from_str("1400.1.2").expect("to parse date");
let end_date = date.add_days(30);
assert_eq!(end_date.game_fmt(), String::from("1400.2.1"));

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 Copy for Date

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 Eq for Date

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

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

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 StructuralEq for Date

impl StructuralPartialEq for Date