Enum Termination 

#[non_exhaustive]
pub enum Termination {
    Timeout(Duration),
    Scheduled(SystemTime),
}

Criteria for exiting the control program

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Timeout(Duration)

A duration after which the control program should terminate. The controller will use the monotonic clock, not system realtime clock, to determine when this threshold occurs; as a result, if used for scheduling relative to a “realtime” date or time, it will accumulate some error as the monotonic clock drifts.

Scheduled(SystemTime)

Schedule termination at a specific “realtime” date or time.

Implementations

impl Termination

pub fn timeout_s(s: f64) -> Self

pub fn scheduled_epoch_ns(ns: u64) -> PyResult<Self>

Trait Implementations

impl Clone for Termination

fn clone(&self) -> Termination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Termination

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Termination

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for Termination

type Target = Termination

The Python output type

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

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for Termination

type LayoutAsBase = PyClassObject<Termination>

type BaseNativeType = <Termination as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<Termination>

type PyClassMutability = <Termination as PyClassImpl>::PyClassMutability

impl PyClassImpl for Termination

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

const RAW_DOC: &'static CStr = /// Criteria for exiting the control program

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Termination>

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyMethods<Termination> for PyClassImplCollector<Termination>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Termination

const NAME: &'static str = "Termination"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

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 Termination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ExtractPyClassWithClone for Termination