Enum PeriodFreq 

#[non_exhaustive]
pub enum PeriodFreq {
    Annual,
    Quarterly,
    Monthly,
    Weekly,
    Daily,
    Business,
    Hourly,
    Minutely,
    Secondly,
}

Period frequency code. Matches pandas offset alias core set.

The ordinal axis is frequency-specific: for Monthly, ordinal 0 is a fixed anchor (pandas uses months since 1970-01). Phase 1 doesn’t commit to a specific epoch yet — the ordinal scheme is opaque until Phase 2 wires calendar arithmetic. What Phase 1 DOES nail down is: same-freq Periods compare + subtract; Period + i64 shifts by n periods of the declared frequency.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Annual

Y-DEC / A / Y — annual periods.

Quarterly

Q-DEC / Q — quarterly periods.

Monthly

M — monthly periods.

Weekly

W-SUN / W — weekly periods.

Daily

D — daily periods.

Business

B — business-day periods.

Hourly

h / H — hourly periods.

Minutely

min / T — minutely periods.

Secondly

s / S — secondly periods.

Implementations

impl PeriodFreq

pub fn parse(alias: &str) -> Option<Self>

Parse a pandas-style frequency alias. Recognizes the common subset (Y-DEC/A/Y, Q-DEC/Q, M, W-SUN/W, D, B, h/H, min/T, s/S). Case-insensitive.

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

Canonical pandas alias string.

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

Per br-frankenpandas-qigpe: resolution string for PeriodIndex.resolution.

Trait Implementations

impl Clone for PeriodFreq

fn clone(&self) -> PeriodFreq

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PeriodFreq

impl Debug for PeriodFreq

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PeriodFreq

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PeriodFreq

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

Formats the value using the given formatter.

impl Eq for PeriodFreq

impl Hash for PeriodFreq

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 PeriodFreq

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PeriodFreq