Struct PyAnyCoupon 

pub(crate) struct PyAnyCoupon {
    pub(crate) inner: AnyCoupon,
}

One coupon of the closed set.

Opaque: it carries no constructor of its own, so the only way to hold one is through the four functions below. That is where the closed set is enforced — in the core’s own enumeration, reached through named constructors, rather than in a kind string this class would have to validate.

Fields

inner: AnyCoupon

Implementations

impl PyAnyCoupon

fn __eq__(&self, other: &Self) -> bool

Structural equality: the same coupon shape with the same terms.

fn kind(&self) -> &'static str

Which kind of coupon this is: the kind column’s spelling.

fn payment_date(&self) -> NaiveDate

The payment date.

fn accrual_start(&self) -> Option<NaiveDate>

Accrual start, or None for a coupon that accrues over nothing.

fn accrual_end(&self) -> Option<NaiveDate>

Accrual end, or None for a coupon that accrues over nothing.

fn fixing_date(&self) -> Option<NaiveDate>

The reset date, for a coupon that has one.

fn notional(&self) -> f64

The notional the coupon accrues on.

Zero for a redemption, which accrues on nothing. Its amount is amount.

fn amount(&self) -> Option<f64>

The amount this flow pays, where the contract alone fixes it.

A redemption’s stated amount, and a fixed coupon’s notional times rate times year fraction. None for a coupon whose rate must be fixed or projected — zero would be indistinguishable from a coupon that pays nothing, and the reading that projects is cashflow_records, which takes a market.

fn year_fraction(&self) -> f64

The accrual year fraction under the coupon’s own day count.

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

The basis the coupon accrues on, or None for one that accrues over nothing — the code the core’s own vocabulary round-trips.

fn currency(&self) -> String

The currency the coupon pays in.

fn contract_rate(&self) -> Option<f64>

The rate written into the contract, for a coupon that carries one — a fixed rate, never a projection.

fn __repr__(&self) -> String

impl PyAnyCoupon

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

impl PyAnyCoupon

unsafe extern "C" fn __pymethod___richcmp____( slf: *mut PyObject, other: *mut PyObject, op: c_int, ) -> *mut PyObject

Trait Implementations

impl Clone for PyAnyCoupon

fn clone(&self) -> PyAnyCoupon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DerefToPyAny for PyAnyCoupon

impl IntoPy<Py<PyAny>> for PyAnyCoupon

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

Performs the conversion.

impl PyClass for PyAnyCoupon

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyAnyCoupon

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<PyAnyCoupon>

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 PyClass__eq__SlotFragment<PyAnyCoupon> for PyClassImplCollector<PyAnyCoupon>

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> for &'a PyAnyCoupon

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

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

impl PyMethods<PyAnyCoupon> for PyClassImplCollector<PyAnyCoupon>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyAnyCoupon

const NAME: &'static str = "AnyCoupon"

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.