Enum DateFreq

pub enum DateFreq {
    Daily,
    WeeklyMonday,
    WeeklyFriday,
    MonthStart,
    MonthEnd,
    QuarterStart,
    QuarterEnd,
    YearStart,
    YearEnd,
}

Represents the frequency at which calendar dates should be generated.

Variants

Daily

WeeklyMonday

WeeklyFriday

MonthStart

MonthEnd

QuarterStart

QuarterEnd

YearStart

YearEnd

Implementations

impl DateFreq

pub fn from_string(freq: String) -> Result<Self, Box<dyn Error>>

Attempts to parse a frequency string into a DateFreq enum.

This is a convenience wrapper around from_str.

Arguments

• freq - The frequency string (e.g., “D”, “W”, “ME”).

Errors

Returns an error if the string does not match any known frequency.

pub fn to_string(&self) -> String

Returns the canonical string representation of the frequency.

This returns the primary code (e.g., “D”, “W”, “Y”, “YE”), not the aliases.

pub fn agg_type(&self) -> AggregationType

Determines whether the frequency represents a start-of-period or end-of-period aggregation.

Trait Implementations

impl Clone for DateFreq

fn clone(&self) -> DateFreq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DateFreq

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

Formats the value using the given formatter.

impl FromStr for DateFreq

fn from_str(freq: &str) -> Result<Self, Self::Err>

Attempts to parse a frequency string slice into a DateFreq enum.

Supports various frequency codes and common aliases.

Code	Alias	Description
D		Daily (every day)
W	WS	Weekly Monday
M	MS	Month Start (1st)
Q	QS	Quarter Start (1st)
Y	A, AS, YS	Year Start (Jan 1st)
ME		Month End (Last day)
QE		Quarter End (Last day)
WF		Weekly Friday
YE	AE	Year End (Dec 31st)

Arguments

• freq - The frequency string slice (e.g., “D”, “W”, “ME”).

Errors

Returns an error if the string does not match any known frequency.

type Err = Box<dyn Error>

The associated error which can be returned from parsing.

impl Hash for DateFreq

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 DateFreq

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

impl Eq for DateFreq

impl StructuralPartialEq for DateFreq