Struct bonsaidb::client::fabruic::Receiver

pub struct Receiver<T>
where
    T: 'static,
{ /* private fields */ }

Used to receive data from a stream. Will stop receiving message if deserialization failed.

Implementations

impl<T> Receiver<T>

pub async fn finish(&self) -> Result<(), AlreadyClosed>

Wait for the Receiver part of the stream to finish gracefully.

This can only be achieved through the peer’s Sender::finish or an error.

Errors

error::AlreadyClosed if it has already been closed.

pub async fn close(&self) -> Result<(), AlreadyClosed>

Close the Receiver immediately. To close a Receiver gracefully use finish.

Errors

error::AlreadyClosed if it has already been closed.

Trait Implementations

impl<T> Clone for Receiver<T>

where T: Clone + 'static,

fn clone(&self) -> Receiver<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> Stream for Receiver<T>

type Item = Result<T, Receiver>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Receiver<T>>, cx: &mut Context<'_> ) -> Poll<Option<<Receiver<T> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.