Struct PyFrequency 

pub(crate) struct PyFrequency {
    inner: Frequency,
}

A coupon frequency: one of the named members, or a period a caller spells (Frequency("28D") for the 28-day markets).

Frequency("6M") is Frequency.SemiAnnual; the two are one value. Once is a single payment at maturity and has no recurring period, so where a schedule is generated it is refused rather than stepped by.

Fields

inner: Frequency

Implementations

impl PyFrequency

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

The member’s Python spelling, where the value is a named one.

impl PyFrequency

fn new(spelling: &str) -> PyResult<Self>

A frequency from its spelling: a member’s name ("SemiAnnual") or a period code ("6M", "28D").

fn __repr__(&self) -> String

fn __str__(&self) -> String

fn code(&self) -> String

The canonical period code ("6M"), or "ONCE".

fn annual() -> Self

fn semi_annual() -> Self

fn quarterly() -> Self

fn bi_monthly() -> Self

fn monthly() -> Self

fn weekly() -> Self

fn daily() -> Self

fn once() -> Self

Trait Implementations

impl Clone for PyFrequency

fn clone(&self) -> PyFrequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PyFrequency

impl Debug for PyFrequency

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

Formats the value using the given formatter.

impl DerefToPyAny for PyFrequency

impl Eq for PyFrequency

impl Hash for PyFrequency

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 IntoPy<Py<PyAny>> for PyFrequency

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for PyFrequency

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

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyFrequency

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyFrequency>

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a PyFrequency

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

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

impl PyMethods<PyFrequency> for PyClassImplCollector<PyFrequency>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyFrequency

const NAME: &'static str = "Frequency"

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_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl StructuralPartialEq for PyFrequency