Enum nuts::LifecycleStatus

#[non_exhaustive]pub enum LifecycleStatus {
    Active,
    Inactive,
    Deleted,
}

Each activity has a lifecycle status that can be changed using set_status. It starts with LifecycleStatus::Active. In the current version of Nuts, the only other status is LifecycleStatus::Inactive.

The inactive status can be used to put activities to sleep temporarily. While inactive, the activity will not be notified of events it has subscribed to. A subscription filter can been used to change this behavior. (See subscribe_masked)

If the status of a changes from active to inactive, the activity's on_leave and on_leave_domained subscriptions will be called.

If the status of a changes from inactive to active, the activity's on_enter and on_enter_domained subscriptions will be called.

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.

Active

The normal status. Every Activity starts with this status.

Inactive

Inactive / Sleeping

Deleted

Mark for deletion, the activity will be removed and on_delete called on it. Setting to this state twice will cause panics.

Implementations

impl LifecycleStatus

pub fn is_active(&self) -> bool

Returns true iff the status is one that is considered to be active. (Only LifecycleStatus::Active at the moment)

Use this method instead of a == comparison with LifecycleStatus::Active to keep compatibility with future versions of Nuts that may add other status variants.

Trait Implementations

impl Clone for LifecycleStatus

pub fn clone(&self) -> LifecycleStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LifecycleStatus

impl Debug for LifecycleStatus

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

Formats the value using the given formatter.

impl Eq for LifecycleStatus

impl Hash for LifecycleStatus

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<LifecycleStatus> for LifecycleStatus

pub fn eq(&self, other: &LifecycleStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for LifecycleStatus

impl StructuralPartialEq for LifecycleStatus