local_channel::mpsc

# Struct Receiver

source

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

Expand description

The receiving end of a channel which implements the `Stream` trait.

This is created by the `channel` function.

## Implementations§

source §

### impl<T> Receiver<T>

source

#### pub async fn recv(&mut self) -> Option<T>

Receive the next value.

Returns `None` if the channel is empty and has been closed explicitly or when all senders have been dropped and, therefore, no more values can ever be sent though this channel.

source

#### pub fn sender(&self) -> Sender<T>

Create an associated Sender.

## 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> Stream for Receiver<T>

source §

#### type Item = T

Values yielded by the stream.
source §

#### fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::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. Read more
§

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

Returns the bounds on the remaining length of the stream. Read more
source §

### impl<T> Unpin for Receiver<T>

## Auto Trait Implementations§

§

### impl<T> Freeze for Receiver<T>

§

### impl<T> !RefUnwindSafe for Receiver<T>

§

### impl<T> !Send for Receiver<T>

§

### impl<T> !Sync 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.
§

### impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

§

#### type Ok = T

The type of successful values yielded by this future
§

#### type Error = E

The type of failures yielded by this future
§

#### fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this `TryStream` as if it were a `Stream`. Read more