Struct ModeChange 

#[non_exhaustive]
pub struct ModeChange<M> {
    pub target: M,
}

A requested change from one mode to another.

Produced inside a Decision when an event triggers a mode transition. The runtime inspects this value to determine whether the system should move to a new mode.

Examples

use ready_active_safe::Decision;

let d: Decision<&str, (), ()> = Decision::transition("active");
let change = d.mode_change();
assert_eq!(change.map(|mc| mc.target), Some("active"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target: M

The mode to transition to.

Trait Implementations

impl<M: Clone> Clone for ModeChange<M>

fn clone(&self) -> ModeChange<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for ModeChange<M>

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

Formats the value using the given formatter.

impl<M: PartialEq> PartialEq for ModeChange<M>

fn eq(&self, other: &ModeChange<M>) -> 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<M: Eq> Eq for ModeChange<M>

impl<M> StructuralPartialEq for ModeChange<M>