Struct jomini::common::RawDate

pub struct RawDate { /* private fields */ }

Common implementation between the different date and time formats.

Space optimized to only need 4 bytes

It may or may not have an hour component.

Paradox games do not follow any traditional calendar and instead view the world on simpler terms: that every year should be treated as a non-leap year.

Years can be negative but can’t be zero.

An hour component is considered present if it is non-zero. This means that games with hours run on a non-traditional clock from 1-24 instead of the traditional 24 hour clock (0-23). An exception is Victoria 3, which has day cycle of (0, 6, 12, 18) hours, but remains consistent in omitting the hour when it is zero.

A raw date has very minimal validation and can support any calendar system as it holds abitrary values for year, month, day, and hours

It is typically recommended to use one of the specialized types: Date, DateHour, or UniformDate as date formats aren’t variable within a game and have less pitfalls.

Implementations

impl RawDate

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

Creates a raw date from a binary integer

use jomini::common::{RawDate, PdsDate};
let date = RawDate::from_binary(56379360).unwrap();
assert_eq!(date.iso_8601().to_string(), String::from("1436-01-01"));

let date2 = RawDate::from_binary(60759371).unwrap();
assert_eq!(date2.iso_8601().to_string(), String::from("1936-01-01T10"));

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

Create a raw date from individual components.

Will return none for an invalid date

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

Create a raw date from individual components.

Will panic on invalid dates

pub fn hour(&self) -> u8

Return the hour component. Range [1, 24]. If zero, then there is no hour

pub fn has_hour(&self) -> bool

Return if this date has an hour component

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

Parses date components from the following formatted text:

• Y.M.D
• Y.M.D.H
• YYYY.MM.DD.HH
• or any variation of the above

A zero component for the hour is disallowed, so the hour must be omitted when parsing to only a date without a time component.

Unlike Date::parse, this will not parse the textual form of the date’s binary representation.

Trait Implementations

impl Clone for RawDate

fn clone(&self) -> RawDate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawDate

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

Formats the value using the given formatter.

impl FromStr for RawDate

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 RawDate

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 RawDate

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

Restrict a value to a certain interval.

impl PartialEq for RawDate

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

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

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

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

impl PartialOrd for RawDate

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

fn year(&self) -> i16

Return year of date

fn month(&self) -> u8

Return month of date

fn day(&self) -> u8

Return day of date

fn game_fmt(&self) -> PdsDateFormatter

Formats the date in the game format

fn iso_8601(&self) -> PdsDateFormatter

Formats the date in an iso8601 format

impl Copy for RawDate

impl Eq for RawDate

impl StructuralPartialEq for RawDate