Struct Period 

pub struct Period {
    pub ordinal: i64,
    pub freq: PeriodFreq,
}

A single pandas-style Period value.

Stored as an integer ordinal on a frequency-specific axis plus the frequency code. Two Periods with different freq are incompatible — arithmetic and comparison require same-freq operands.

Fields

ordinal: i64

freq: PeriodFreq

Implementations

impl Period

pub const fn new(ordinal: i64, freq: PeriodFreq) -> Self

pub const fn ordinal(&self) -> i64

Integer position on this period’s frequency axis, matching pd.Period.ordinal.

pub const fn freq(&self) -> PeriodFreq

Frequency code for this period, matching pd.Period.freq.

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

Canonical pandas frequency alias, matching pd.Period.freqstr.

pub fn cmp_same_freq(&self, other: &Self) -> Option<Ordering>

Same-freq ordinal comparison. Returns None if freq differs — caller decides whether that’s an error or a panic site.

pub fn shift(&self, n: i64) -> Self

Shift by n periods of the current frequency. Matches pd.Period + n and pd.Period - n.

pub fn diff(&self, other: &Self) -> Option<i64>

Period-difference in units of the shared frequency. Returns None if freq differs (pandas raises IncompatibleFrequency).

pub fn parse(s: &str) -> Result<Self, TypeError>

Parse common pandas Period(...) strings and infer the frequency.

Supported forms mirror pandas’ unambiguous scalar constructor cases: annual ("2024"), quarterly ("2024Q1"), monthly ("2024-01"), and daily ("2024-01-15"). The ordinal axes match pandas: 1970, 1970Q1, 1970-01, and 1970-01-01 all have ordinal 0.

pub fn calendar_string(&self) -> String

Pandas calendar string for this period, matching str(pd.Period).

Inverts the frequency-specific ordinal axes anchored at 1970: 1970/1970Q1/1970-01/1970-01-01/1970-01-01 00:00 all have ordinal 0. Returns "NaT" for the missing sentinel (i64::MIN).

Annual/Quarterly/Monthly/Daily and the sub-daily clocks (Hourly/Minutely/Secondly) are exact. Weekly and Business use a best-effort YYYY-MM-DD rendering (their pandas axes — a Sunday-ended week range and a business-day count — are not yet wired; neither is reachable through the current parse/cast paths).

Trait Implementations

impl Clone for Period

fn clone(&self) -> Period

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Period

impl Debug for Period

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Period

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Period

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

Pandas str(Period) form: the calendar string (2024, 2024Q1, 2024-03, 2024-01-15, …). NaT (ordinal i64::MIN) renders NaT.

impl Eq for Period

impl Hash for Period

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 PartialEq for Period

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

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 Period