Struct ScriptDate

pub struct ScriptDate {
    pub year: u16,
    pub month: u8,
    pub day: u8,
}

Representation of a date of introduction for a script code. This contains year, month, and day public fields of u16 type.

Examples

Create a new valid ScriptDate:

use iso15924::ScriptDate;

let _ = ScriptDate::new(1976, 7, 2);

Check if a ScriptDate is equal to, less than, etc. another ScriptDate:

use iso15924::ScriptDate;

let date1 = ScriptDate::new(1997, 7, 7);
let date2 = ScriptDate::new(2005, 5, 5);

// Check that `date1` is not equal to `date2`.
assert_ne!(date1, date2);

// Check that `date1` is less than `date2`.
assert!(date1 < date2);

// Check that `date2` is greater than `date1`.
assert!(date2 > date1);

Fields

year: u16

The year of the date that a code was introduced.

month: u8

The month of the date that a code was introduced.

day: u8

The day of the date that a code was introduced.

Implementations

impl ScriptDate

pub const fn new(year: u16, month: u8, day: u8) -> Self

Creates a new ScriptDate from the given year, month, and day, if possible.

This doesn’t check the input for a valid month and day. If you need that, use the TryFrom impl.

Examples

Create a new valid ScriptDate:

use iso15924::ScriptDate;

let _ = ScriptDate::new(2000, 1, 1);

Trait Implementations

impl Clone for ScriptDate

fn clone(&self) -> ScriptDate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptDate

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

Formats the value using the given formatter.

impl FromStr for ScriptDate

type Err = ScriptDateError

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 ScriptDate

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 ScriptDate

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

Restrict a value to a certain interval.

impl PartialEq for ScriptDate

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ScriptDate

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<(u16, u8, u8)> for ScriptDate

type Error = ScriptDateError

The type returned in the event of a conversion error.

fn try_from((year, month, day): (u16, u8, u8)) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ScriptDate

impl Eq for ScriptDate