Struct Cal

pub struct Cal {
    pub holidays: IndexSet<NaiveDateTime>,
    pub week_mask: HashSet<Weekday>,
}

A basic business day calendar containing holidays.

Fields

holidays: IndexSet<NaiveDateTime>

A vector of specific dates that are defined as non-business days.

week_mask: HashSet<Weekday>

A vector of days in the week that are defined as non-business days. E.g. [5, 6] for Saturday and Sunday.

Implementations

impl Cal

pub fn new(holidays: Vec<NaiveDateTime>, week_mask: Vec<u8>) -> Self

Create a Cal.

Examples

let cal = Cal::new(vec![ndt(2017, 5, 1)], vec![5, 6]); // With May Bank Holiday
let spot = cal.add_bus_days(&ndt(2017, 4, 28), 2, true);
assert_eq!(ndt(2017, 5, 3), spot);

pub fn try_from_name(name: &str) -> Result<Cal, PyErr>

Return a Cal specified by a pre-defined named identifier.

For available 3-digit names see named module documentation.

Examples

let ldn_cal = Cal::try_from_name("ldn").unwrap();

Trait Implementations

impl CalendarAdjustment for Cal

fn adjust(&self, udate: &NaiveDateTime, adjuster: &Adjuster) -> NaiveDateTime

where Self: Sized + DateRoll,

Adjust a date under an adjustment rule.

fn adjusts( &self, udates: &Vec<NaiveDateTime>, adjuster: &Adjuster, ) -> Vec<NaiveDateTime>

where Self: Sized + DateRoll,

Adjust a vector of dates under an adjustment rule;

impl Clone for Cal

fn clone(&self) -> Cal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DateRoll for Cal

fn is_weekday(&self, date: &NaiveDateTime) -> bool

Returns whether the date is part of the general working week.

fn is_holiday(&self, date: &NaiveDateTime) -> bool

Returns whether the date is a specific holiday excluded from the regular working week.

fn is_settlement(&self, _date: &NaiveDateTime) -> bool

Returns whether the date is valid relative to an associated settlement calendar.

fn is_bus_day(&self, date: &NaiveDateTime) -> bool

Returns whether the date is a business day, i.e. part of the working week and not a holiday.

fn is_non_bus_day(&self, date: &NaiveDateTime) -> bool

Returns whether the date is not a business day, i.e. either not in working week or a specific holiday.

fn roll_forward_bus_day(&self, date: &NaiveDateTime) -> NaiveDateTime

Return the date, if a business day, or get the next business date after date.

fn roll_backward_bus_day(&self, date: &NaiveDateTime) -> NaiveDateTime

Return the date, if a business day, or get the business day preceding date.

fn roll_mod_forward_bus_day(&self, date: &NaiveDateTime) -> NaiveDateTime

Return the date, if a business day, or get the proceeding business date, without rolling into a new month.

fn roll_mod_backward_bus_day(&self, date: &NaiveDateTime) -> NaiveDateTime

Return the date, if a business day, or get the proceeding business date, without rolling into a new month.

fn roll_forward_settled_bus_day(&self, date: &NaiveDateTime) -> NaiveDateTime

Return the date, if a business day that can be settled, or the proceeding date that is such.

fn roll_backward_settled_bus_day(&self, date: &NaiveDateTime) -> NaiveDateTime

Return the date, if a business day that can be settled, or the preceding date that is such.

fn roll_forward_mod_settled_bus_day( &self, date: &NaiveDateTime, ) -> NaiveDateTime

Return the date, if a business day that can be settled, or get the proceeding such date, without rolling into a new month.

fn roll_backward_mod_settled_bus_day( &self, date: &NaiveDateTime, ) -> NaiveDateTime

Return the date, if a business day that can be settled, or get the preceding such date, without rolling into a new month.

fn lag_bus_days( &self, date: &NaiveDateTime, days: i32, settlement: bool, ) -> NaiveDateTime

Adjust a date by a number of business days, under lag rules.

fn add_cal_days( &self, date: &NaiveDateTime, days: i32, adjuster: &Adjuster, ) -> NaiveDateTime

where Self: Sized,

Add a given number of calendar days to a date with the result adjusted to a business day that may or may not allow settlement.

fn add_bus_days( &self, date: &NaiveDateTime, days: i32, settlement: bool, ) -> Result<NaiveDateTime, PyErr>

Add a given number of business days to a date with the result adjusted to a business day that may or may not allow settlement.

fn bus_date_range( &self, start: &NaiveDateTime, end: &NaiveDateTime, ) -> Result<Vec<NaiveDateTime>, PyErr>

Return a vector of business dates between a start and end, inclusive.

fn cal_date_range( &self, start: &NaiveDateTime, end: &NaiveDateTime, ) -> Result<Vec<NaiveDateTime>, PyErr>

Return a vector of calendar dates between a start and end, inclusive

impl Debug for Cal

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

Formats the value using the given formatter.

impl Default for Cal

fn default() -> Cal

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Cal> for Calendar

fn from(item: Cal) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for Cal

type Target = Cal

The Python output type

type Output = Bound<'py, <Cal 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 JSON for Cal

fn to_json(&self) -> Result<String>

Return a JSON string representing the object.

fn from_json(json: &str) -> Result<Self>

Create an object from a JSON string representation.

impl PartialEq<NamedCal> for Cal

fn eq(&self, other: &NamedCal) -> 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 PartialEq<UnionCal> for Cal

fn eq(&self, other: &UnionCal) -> 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 PartialEq for Cal

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Cal

const IS_BASETYPE: bool = false

#[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<Cal>

This handles following two situations:

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

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<Cal> for PyClassImplCollector<Cal>

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

impl PyClass__eq__SlotFragment<Cal> for PyClassImplCollector<Cal>

unsafe fn __eq__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

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

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut Cal

type Holder = Option<PyRefMut<'py, Cal>>

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

impl PyMethods<Cal> for PyClassImplCollector<Cal>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Cal

const NAME: &'static str = "Cal"

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 Cal

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for Cal

impl StructuralPartialEq for Cal