Struct appliance::Descriptor

pub struct Descriptor<'a, A: ?Sized> { /* fields omitted */ }

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

Once all descriptors to the appliance are dropped, the appliance will terminate its event loop and be destroyed.

Implementations

impl<'a, A: ?Sized + 'a> Descriptor<'a, A>

pub fn send_sync<M>(&self, message: M) -> Result<(), Error<M>> where
    M: HandledBy<A> + 'a, 

Sends a message to the current appliance without waiting for the message to be handled.

pub async fn send_async<M>(&self, message: M) -> Result<(), Error<M>> where
    M: HandledBy<A> + 'a, 

Does conceptually the same thing as send_sync but gets intended to be used in async context.

pub fn send_and_wait_sync<M>(
    &self,
    message: M,
    timeout: Option<Duration>
) -> Result<M::Result, Error<M>> where
    M: HandledBy<A> + 'a, 

Sends a message to the current appliance and waits forever, if timeout is None, or for only given time for the message to be handled. This synchronous blocking method is a fit for callers who don’t use async execution and must be assured that the message has been handled. Note, it is supposed to be used less often than send as it may suffer a significant performance hit due to synchronization with the handling loop.

pub async fn send_and_wait_async<M>(
    &self,
    message: M,
    timeout: Option<Duration>
) -> Result<M::Result, Error<M>> where
    M: HandledBy<A> + 'a, 

Does conceptually the same thing as send_and_wait_sync but gets intended to be used in async context. This method is well suited for waiting for a result.

Trait Implementations

impl<'a, A: ?Sized + 'a> Clone for Descriptor<'a, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, A: ?Sized + 'a> Debug for Descriptor<'a, A>

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

Formats the value using the given formatter.