Receiver

Struct Receiver 

Source
pub struct Receiver<T> { /* private fields */ }
Expand description

Receives a value from the associated Sender.

Implementations§

Source§

impl<T> Receiver<T>

Source

pub fn is_closed(&self) -> bool

Returns true if the associated Sender was dropped before sending a message. Or if the message has already been received.

If true is returned, all future calls to receive the message are guaranteed to return RecvError. And future calls to this method is guaranteed to also return true.

Source

pub fn has_message(&self) -> bool

Returns true if there is a message in the channel, ready to be received.

If true is returned, the next call to receive the message is guaranteed to return the message immediately.

Source

pub fn try_recv(&self) -> Result<Option<T>, RecvError>

Checks if there is a message in the channel without blocking. Returns:

  • Ok(Some(message)) if there was a message in the channel.
  • Ok(None) if the Sender is alive, but has not yet sent a message.
  • Err(RecvError) if the Sender was dropped before sending anything or if the message has already been extracted by a previous try_recv call.

If a message is returned, the channel is disconnected and any subsequent receive operation using this receiver will return an RecvError.

Trait Implementations§

Source§

impl<T: Debug> Debug for Receiver<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Drop for Receiver<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<T> IntoFuture for Receiver<T>

Source§

type Output = Result<T, RecvError>

The output that the future will produce on completion.
Source§

type IntoFuture = Recv<T>

Which kind of future are we turning this into?
Source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more
Source§

impl<T: Send> Send for Receiver<T>

Auto Trait Implementations§

§

impl<T> Freeze for Receiver<T>

§

impl<T> !RefUnwindSafe for Receiver<T>

§

impl<T> !Sync for Receiver<T>

§

impl<T> Unpin for Receiver<T>

§

impl<T> !UnwindSafe for Receiver<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.