Struct MonthIndex

#[repr(transparent)]
pub struct MonthIndex(pub f32);

0-based Month representation.

Internally stores the month as f32 in the range 0.0..=11.0, corresponding to:

• 0.0 -> January (Morning Star)
• 1.0 -> February (Sun’s Dawn)
• 11.0 -> December (Evening Star)

Example

use commonlibsse_ng::re::Calendar::MonthIndex;

let month = MonthIndex::new(0.0);
assert_eq!(month.to_clamp_month(), Some(1)); // 1-based month

let month = MonthIndex::new(11.0);
assert_eq!(month.to_clamp_month(), Some(12)); // Evening Star

let month = MonthIndex::new(12.0);
assert_eq!(month.to_clamp_month(), None); // Out of range

Tuple Fields

0: f32

Implementations

impl MonthIndex

pub const DEFAULT: Self

The default month value (0.0 -> MorningStar).

pub const fn new(value: f32) -> Self

Creates a new MonthIndex instance with the specified value.

Example

let month = MonthIndex::new(5.0);
assert_eq!(month.0, 5.0);

pub const fn to_clamp_month(self) -> Option<u32>

Returns the 1-based month (1..=12) if the value is valid, otherwise None.

• 0.0 → 1 (January)
• 11.0 → 12 (December)

Returns None if the value is out of the valid range (0.0..=11.0).

Example (Boundary Tests)

assert_eq!(MonthIndex::new(0.0).to_clamp_month(), Some(1));    // Morning Star
assert_eq!(MonthIndex::new(11.0).to_clamp_month(), Some(12));  // Evening Star
assert_eq!(MonthIndex::new(12.0).to_clamp_month(), None);      // Out of range
assert_eq!(MonthIndex::new(-1.0).to_clamp_month(), None);      // Out of range

pub const fn to_enum(self) -> Option<MonthInGame>

Converts MonthIndex into MonthInGame enum if the value is valid.

Returns None if the value is out of range (0.0..=11.0).

Example

let month = MonthIndex::new(0.0);
assert_eq!(month.to_enum(), Some(MonthInGame::MorningStar));

let invalid_month = MonthIndex::new(12.0);
assert_eq!(invalid_month.to_enum(), None);

Trait Implementations

impl Clone for MonthIndex

fn clone(&self) -> MonthIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MonthIndex

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

Formats the value using the given formatter.

impl Default for MonthIndex

fn default() -> MonthIndex

Returns the “default value” for a type.

impl From<MonthInGame> for MonthIndex

fn from(month: MonthInGame) -> Self

Converts to this type from the input type.

impl PartialEq for MonthIndex

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

impl StructuralPartialEq for MonthIndex