Struct jomini::common::DateHour

pub struct DateHour { /* private fields */ }

A date with an hour component

Geared towards the hearts of iron games.

See RawDate for additional date / time commentary

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 1, 24);
let iso = date.iso_8601().to_string();
assert_eq!(iso, String::from("1936-01-01T23"));

Implementations

impl DateHour

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

Create a new DateHour from individual components

The hour is expected to be non-zero in addition to the validation that a regular Date object undergoes.

use jomini::common::DateHour;
assert!(DateHour::from_ymdh_opt(1936, 1, 1, 24).is_some());
assert!(DateHour::from_ymdh_opt(1936, 1, 1, 0).is_none());

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

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 3, 12);
assert_eq!(date.day(), 3);

pub fn hour(&self) -> u8

hour of the date. Range: [1, 24]

use jomini::common::DateHour;
let date = DateHour::from_ymdh(1936, 1, 2, 12);
assert_eq!(date.hour(), 12);

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

Parse a DateHour from text. Follows the same logic as RawDate::parse except an hour component is enforced.

use jomini::common::DateHour;
assert_eq!(DateHour::parse("1936.1.1.24"), Ok(DateHour::from_ymdh(1936, 1, 1, 24)));

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

Decode a number extracted from the binary format into a date.

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

Decode a number extracted from the binary format into a date, but ensure that the date is at least in the 1800’s (an arbitrary chosen value to support HOI4 mods that move the start date up). There is a special exception made for 1.1.1.1 and -1.1.1.1 which represents an event that has not occurred yet.

pub fn to_binary(self) -> i32

Converts a date into the binary representation

use jomini::common::DateHour;
let date = DateHour::from_ymdh(1, 1, 1, 1);
assert_eq!(43808760, date.to_binary());

Trait Implementations

impl Clone for DateHour

fn clone(&self) -> DateHour

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DateHour

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DateHour

fn deserialize<D>(deserializer: D) -> Result<DateHour, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for DateHour

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 DateHour

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 DateHour

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

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

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

fn year(&self) -> i16

Year of the date

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 2, 24);
assert_eq!(date.year(), 1936);

fn month(&self) -> u8

Month of the date

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 2, 24);
assert_eq!(date.month(), 1);

fn day(&self) -> u8

Day of the date

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 2, 24);
assert_eq!(date.day(), 2);

fn iso_8601(&self) -> PdsDateFormatter

Return the date as an iso8601 compatible string

The hour component is converted to a range of [0, 23] per the spec

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 2, 12);
assert_eq!(String::from("1936-01-02T11"), date.iso_8601().to_string());

fn game_fmt(&self) -> PdsDateFormatter

Return the date in the game format

use jomini::common::{DateHour, PdsDate};
let date = DateHour::from_ymdh(1936, 1, 2, 12);
assert_eq!(String::from("1936.1.2.12"), date.game_fmt().to_string());

impl Serialize for DateHour

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 DateHour

impl Eq for DateHour

impl StructuralPartialEq for DateHour