Struct jomini::common::UniformDate

pub struct UniformDate { /* fields omitted */ }

A date without a time component where each month has 30 days

Useful for Stellaris

See RawDate for additional date / time commentary

Implementations

impl UniformDate

pub fn from_ymd_opt(year: i16, 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::{PdsDate, UniformDate};
assert_eq!(UniformDate::from_ymd_opt(1444, 11, 11), Some(UniformDate::from_ymd(1444, 11, 11)));
assert_eq!(UniformDate::from_ymd_opt(800, 5, 3), Some(UniformDate::from_ymd(800, 5, 3)));
assert!(UniformDate::from_ymd_opt(800, 0, 3).is_none());
assert!(UniformDate::from_ymd_opt(800, 1, 0).is_none());
assert!(UniformDate::from_ymd_opt(800, 13, 1).is_none());
assert!(UniformDate::from_ymd_opt(800, 12, 32).is_none());
assert!(UniformDate::from_ymd_opt(2020, 2, 29).is_some());

pub fn from_ymd(year: i16, month: u8, day: u8) -> Self

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

Will panic if the date does not exist.

pub fn parse<T: AsRef<[u8]>>(s: T) -> Result<Self, DateError>

Parse a DateHour from text. Follows the same logic as RawDate::parse except that a 12 month calendar of 30 days is enforced.

use jomini::common::UniformDate;
assert_eq!(UniformDate::parse("2200.02.30"), Ok(UniformDate::from_ymd(2200, 2, 30)));

Trait Implementations

impl Clone for UniformDate

fn clone(&self) -> UniformDate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UniformDate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UniformDate

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

Deserialize this value from the given Serde deserializer.

impl FromStr for UniformDate

type Err = DateError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for UniformDate

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for UniformDate

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<UniformDate> for UniformDate

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

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

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

This method tests for !=.

impl PartialOrd<UniformDate> for UniformDate

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

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

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

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

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

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

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

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

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 PdsDate for UniformDate

fn year(&self) -> i16

Year of the date

use jomini::common::{UniformDate, PdsDate};
let date = UniformDate::from_ymd(1444, 2, 3);
assert_eq!(date.year(), 1444);

fn month(&self) -> u8

Month of the date

use jomini::common::{UniformDate, PdsDate};
let date = UniformDate::from_ymd(1444, 2, 3);
assert_eq!(date.month(), 2);

fn day(&self) -> u8

Day of the date

use jomini::common::{UniformDate, PdsDate};
let date = UniformDate::from_ymd(1444, 2, 3);
assert_eq!(date.day(), 3);

fn iso_8601(&self) -> PdsDateFormatter

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

use jomini::common::{UniformDate, PdsDate};
let date = UniformDate::from_ymd(1400, 1, 2);
assert_eq!(date.iso_8601().to_string(), String::from("1400-01-02"));

fn game_fmt(&self) -> PdsDateFormatter

Formats a date in the game format: Y.MM.DD

use jomini::common::{UniformDate, PdsDate};
let date = UniformDate::from_ymd(1400, 1, 2);
assert_eq!(date.game_fmt().to_string(), String::from("1400.01.02"));

impl Copy for UniformDate

impl Eq for UniformDate

impl StructuralEq for UniformDate

impl StructuralPartialEq for UniformDate