Enum RollDay

pub enum RollDay {
    Day(u32),
    IMM(),
}

A roll-day used with a Frequency::Months variant.

Variants

Day(u32)

A day of the month in [1, 31].

IMM()

The third Wednesday of any month (equivalent to Imm::Wed3)

Implementations

impl RollDay

pub fn vec_from(udates: &Vec<NaiveDateTime>) -> Vec<Self>

Get all possible RollDay variants implied from one or more unadjusted dates.

Notes

Each date is analysed in turn. The order of RollDay construction for each date is:

• Get the integer roll-day of the date.
• Get additional end-of-month related integer roll-days for short calendar months if necessary.
• Get non-numeric roll-days if date aligns with those, ordered by the underlying enum order.

When multiple dates are checked the results for a subsequent date is added to the prior results under the [IndexSet.intersection] ordering rules.

Any date will always return at least one RollDay and the first one will always be equivalent to an integer variant whose day equals the calendar day of the first date.

Examples

let result = RollDay::vec_from(&vec![ndt(2024, 2, 29), ndt(2024, 3, 20), ndt(2024, 3, 31)]);
assert_eq!(result, vec![
    RollDay::Day(29),
    RollDay::Day(30),
    RollDay::Day(31),
    RollDay::Day(20),
    RollDay::IMM(),
]);

pub fn try_udate(&self, udate: &NaiveDateTime) -> Result<NaiveDateTime, PyErr>

Validate whether an unadjusted date is an allowed value under the RollDay definition.

Examples

let date = RollDay::Day(31).try_udate(&ndt(2024, 2, 29));
assert!(date.is_ok());

let date = RollDay::IMM().try_udate(&ndt(2024, 1, 1));
assert!(date.is_err());

pub fn try_uadd( &self, udate: &NaiveDateTime, months: i32, ) -> Result<NaiveDateTime, PyErr>

Add a given number of months to an unadjusted date under the RollDay definition.

Notes

This method will also check the given udate using RollDay::try_udate.

Examples

let date = RollDay::IMM().try_uadd(&ndt(2024, 3, 20), 3);
assert_eq!(ndt(2024, 6, 19), date.unwrap());

let date = RollDay::Day(31).try_uadd(&ndt(2024, 3, 15), 3);
assert!(date.is_err());

pub fn uadd(&self, udate: &NaiveDateTime, months: i32) -> NaiveDateTime

Add a given number of months to an unadjusted date under the RollDay definition.

Examples

let date = RollDay::Day(31).uadd(&ndt(2024, 3, 15), 3);
assert_eq!(date, ndt(2024, 6, 30));

pub fn try_from_ym(&self, year: i32, month: u32) -> Result<NaiveDateTime, PyErr>

Return a specific date given the month, year that aligns with the RollDay.

Examples

let date = RollDay::Day(31).try_from_ym(2024, 2);
assert_eq!(date, ndt(2024, 2, 29));

Trait Implementations

impl Clone for RollDay

fn clone(&self) -> RollDay

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RollDay

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RollDay

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RollDay

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<'py> IntoPyObject<'py> for RollDay

type Target = RollDay

The Python output type

type Output = Bound<'py, <RollDay as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for RollDay

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

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for RollDay

type LayoutAsBase = PyClassObject<RollDay>

type BaseNativeType = <RollDay as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<RollDay>

type PyClassMutability = <RollDay as PyClassImpl>::PyClassMutability

impl PyClassImpl for RollDay

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RollDay>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<RollDay> for PyClassImplCollector<RollDay>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a RollDay

type Holder = Option<PyRef<'py, RollDay>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<RollDay> for PyClassImplCollector<RollDay>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RollDay

const NAME: &'static str = "RollDay"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for RollDay

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RollDay

impl Eq for RollDay

impl StructuralPartialEq for RollDay