Struct appliance::Appliance

pub struct Appliance<'s, S> { /* fields omitted */ }

A stateful entity that only allows to interact with via sending messages.

The appliance itself is not directly available. Messages must be sent to it using its descriptor which is returned by the Appliance::new_bounded and Appliance::new_unbounded methods, and can also be obtained from &Appliance using Appliance::descriptor method. Note that the latter route is generally available only for message handler Handler implementations.

Implementations

impl<'s, S> Appliance<'s, S> where
    S: Send + 's, 

pub fn new_bounded(
    executor: &'s Executor<'s>,
    state: S,
    size: usize
) -> Descriptor<'s, Self>

Creates a new appliance with a bounded message buffer, a state, and a handler.

pub fn new_unbounded(
    executor: &'s Executor<'s>,
    state: S
) -> Descriptor<'s, Self>

Creates a new appliance with an unbounded message buffer, a state, and a handler. It’s not recommended to use this version of appliance in production just like any other memory unbounded contruct.

pub fn descriptor(&'s self) -> Option<Descriptor<'s, Self>>

Returns a descriptor object of the appliance.

Any descriptor is a cloneable object which allows to send messages to the appliance.

This function will return None if all appliance descriptors have already been dropped. In this case the appliance becomes unusable.

pub fn state(&mut self) -> &mut S

The mutable inner state of the appliance.

Note that this function requires mutable access to the appliance itself (not its descriptor), but the appliance object is never returned by the API. The only place where the appliance can be accessed is the implementation of Handler and HandledBy traits for the message types, which is thus also the only place where one can (and should) mutate its state.

Trait Implementations

impl<'s, S: Debug + 's> Debug for Appliance<'s, S>

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

Formats the value using the given formatter.