Enum MonthInGame

#[repr(u32)]
pub enum MonthInGame {
    MorningStar = 0,
    SunsDawn = 1,
    FirstSeed = 2,
    RainsHand = 3,
    SecondSeed = 4,
    Midyear = 5,
    SunsHeight = 6,
    LastSeed = 7,
    Hearthfire = 8,
    Frostfall = 9,
    SunsDusk = 10,
    EveningStar = 11,
}

Represents the months of the year.

The internal values correspond to 0-based month indexing:

• 0 → January (MorningStar)
• 1 → February (SunsDawn)
• 11 → December (EveningStar)

Example

let month = MonthInGame::FirstSeed;
assert_eq!(month.as_str(), "First Seed");

Variants

MorningStar = 0

SunsDawn = 1

FirstSeed = 2

RainsHand = 3

SecondSeed = 4

Midyear = 5

SunsHeight = 6

LastSeed = 7

Hearthfire = 8

Frostfall = 9

SunsDusk = 10

EveningStar = 11

Implementations

impl MonthInGame

pub const fn as_str(&self) -> &'static str

Returns the string representation of the month name.

Example

let month = MonthInGame::Midyear;
assert_eq!(month.as_str(), "Midyear");

pub const fn from_u32(month: u32) -> Option<Self>

Converts a u32 value into the corresponding MonthInGame enum.

Returns None if the value is out of range (0..=11).

Example

assert_eq!(MonthInGame::from_u32(0), Some(MonthInGame::MorningStar));  // January
assert_eq!(MonthInGame::from_u32(11), Some(MonthInGame::EveningStar)); // December
assert_eq!(MonthInGame::from_u32(12), None);                          // Out of range
assert_eq!(MonthInGame::from_u32(100), None);                         // Out of range

Trait Implementations

impl Clone for MonthInGame

fn clone(&self) -> MonthInGame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MonthInGame

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

Formats the value using the given formatter.

impl Default for MonthInGame

fn default() -> MonthInGame

Returns the “default value” for a type.

impl Display for MonthInGame

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

Formats the value using the given formatter.

impl From<MonthInGame> for MonthIndex

fn from(month: MonthInGame) -> Self

Converts to this type from the input type.

impl Hash for MonthInGame

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 MonthInGame

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

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

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

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(index: MonthIndex) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MonthInGame

impl Eq for MonthInGame

impl StructuralPartialEq for MonthInGame