Struct capnp_futures::Sender

pub struct Sender<M>
where
    M: AsOutputSegments,
{ /* private fields */ }

A handle that allows messages to be sent to a write queue.

Implementations

impl<M> Sender<M>

where M: AsOutputSegments,

pub fn send( &mut self, message: M ) -> impl Future<Output = Result<M, Error>> + Unpin

Enqueues a message to be written. The returned future resolves once the write has completed.

pub fn len(&self) -> usize

Returns the number of messages queued to be written.

pub fn is_empty(&self) -> bool

pub fn terminate( &mut self, result: Result<(), Error> ) -> impl Future<Output = Result<(), Error>> + Unpin

Commands the queue to stop writing messages once it is empty. After this method has been called, any new calls to send() will return a future that immediately resolves to an error. If the passed-in result is an error, then the WriteQueue will resolve to that error.

Trait Implementations

impl<M> Clone for Sender<M>

where M: AsOutputSegments,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.