Enum ComponentState

#[repr(C)]
pub enum ComponentState {
    PreInitialized = 0,
    Ready = 1,
    Starting = 2,
    Running = 3,
    Stopping = 4,
    Stopped = 5,
    Resuming = 6,
    Resetting = 7,
    Disposing = 8,
    Disposed = 9,
    Degrading = 10,
    Degraded = 11,
    Faulting = 12,
    Faulted = 13,
}

The state of a component within the system.

Variants

PreInitialized = 0

When a component is instantiated, but not yet ready to fulfill its specification.

Ready = 1

When a component is able to be started.

Starting = 2

When a component is executing its actions on start.

Running = 3

When a component is operating normally and can fulfill its specification.

Stopping = 4

When a component is executing its actions on stop.

Stopped = 5

When a component has successfully stopped.

Resuming = 6

When a component is started again after its initial start.

Resetting = 7

When a component is executing its actions on reset.

Disposing = 8

When a component is executing its actions on dispose.

Disposed = 9

When a component has successfully shut down and released all of its resources.

Degrading = 10

When a component is executing its actions on degrade.

Degraded = 11

When a component has successfully degraded and may not meet its full specification.

Faulting = 12

When a component is executing its actions on fault.

Faulted = 13

When a component has successfully shut down due to a detected fault.

Implementations

impl ComponentState

pub const fn from_repr(discriminant: usize) -> Option<ComponentState>

Try to create Self from the raw representation

Trait Implementations

impl Clone for ComponentState

fn clone(&self) -> ComponentState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComponentState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ComponentState

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

Formats the value using the given formatter.

impl FromStr for ComponentState

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ComponentState, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ComponentState

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 IntoEnumIterator for ComponentState

type Iterator = ComponentStateIter

fn iter() -> ComponentStateIter

impl IntoPy<Py<PyAny>> for ComponentState

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

Performs the conversion.

impl Ord for ComponentState

fn cmp(&self, other: &ComponentState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ComponentState

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

fn partial_cmp(&self, other: &ComponentState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for ComponentState

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for ComponentState

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

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<'a, 'py> PyFunctionArgument<'a, 'py> for &'a ComponentState

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut ComponentState

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

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

impl PyTypeInfo for ComponentState

const NAME: &'static str = "ComponentState"

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 Serialize for ComponentState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ComponentState

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ComponentState, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for ComponentState

impl Eq for ComponentState

impl StructuralPartialEq for ComponentState