Struct PyPeriod 

pub struct PyPeriod {
    pub(crate) inner: Period,
}

A tenor: a signed count of days, weeks, months or years, or the whole term.

Period("3M") or Period(3, "M"). Equality and hashing are by duration (Period("12M") == Period("1Y")); ordering is by duration where it is decidable and raises where it is not (1M against 30D); + and - combine tenors of one unit family (days and weeks, months and years).

Fields

inner: Period

Implementations

impl PyPeriod

fn new( spelling_or_count: &Bound<'_, PyAny>, unit: Option<&str>, ) -> PyResult<Self>

A tenor from its spelling ("3M", "-1Y", "2W"), or from a count and a unit code (3, "M").

fn multiplier(&self) -> i32

The signed count.

fn unit(&self) -> String

The unit code: "D", "W", "M", "Y" or "T".

fn in_months(&self) -> Option<i32>

The length in whole months, or None for days, weeks or the term.

fn in_days(&self) -> Option<i32>

The length in days, or None for months, years or the term — none of which is a fixed number of days.

fn normalize(&self) -> Self

The same tenor in the largest unit that states it exactly (12M is 1Y, 14D is 2W).

fn __str__(&self) -> String

fn __repr__(&self) -> String

fn __hash__(&self) -> u64

fn __richcmp__( &self, other: &Bound<'_, PyAny>, op: CompareOp, ) -> PyResult<Py<PyAny>>

fn __add__(&self, other: PyPeriod) -> PyResult<Self>

fn __sub__(&self, other: PyPeriod) -> PyResult<Self>

impl PyPeriod

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

impl PyPeriod

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

Trait Implementations

impl Clone for PyPeriod

fn clone(&self) -> PyPeriod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DerefToPyAny for PyPeriod

impl IntoPy<Py<PyAny>> for PyPeriod

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

Performs the conversion.

impl PyClass for PyPeriod

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyPeriod

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

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

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

impl PyClass__add__SlotFragment<PyPeriod> for PyClassImplCollector<PyPeriod>

unsafe fn __add__( 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 PyClass__sub__SlotFragment<PyPeriod> for PyClassImplCollector<PyPeriod>

unsafe fn __sub__( 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 PyPeriod

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

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

impl PyMethods<PyPeriod> for PyClassImplCollector<PyPeriod>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyPeriod

const NAME: &'static str = "Period"

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.