Struct tokio::sync::mpsc::Receiver

source · [−]
pub struct Receiver<T> { /* private fields */ }
Expand description

Receive values from the associated Sender.

Instances are created by the channel function.

Implementations

Receives the next value for this receiver.

None is returned when all Sender halves have dropped, indicating that no further values can be sent on the channel.

Examples
use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let (mut tx, mut rx) = mpsc::channel(100);

    tokio::spawn(async move {
        tx.send("hello").await.unwrap();
    });

    assert_eq!(Some("hello"), rx.recv().await);
    assert_eq!(None, rx.recv().await);
}

Values are buffered:

use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let (mut tx, mut rx) = mpsc::channel(100);

    tx.send("hello").await.unwrap();
    tx.send("world").await.unwrap();

    assert_eq!(Some("hello"), rx.recv().await);
    assert_eq!(Some("world"), rx.recv().await);
}

Attempts to return a pending value on this receiver without blocking.

This method will never block the caller in order to wait for data to become available. Instead, this will always return immediately with a possible option of pending data on the channel.

This is useful for a flavor of “optimistic check” before deciding to block on a receiver.

Compared with recv, this function has two failure cases instead of one (one for disconnection, one for an empty buffer).

Closes the receiving half of a channel, without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

Trait Implementations

Formats the value using the given formatter. Read more

Values yielded by the stream.

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

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

Consumes and returns the next value in the stream or None if the stream is finished. Read more

Consumes and returns the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

Combine two streams into one by interleaving the output of both as it is produced. Read more

Filters the values produced by this stream according to the provided predicate. Read more

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided closure. Read more

Creates a stream which ends after the first None. Read more

Creates a new stream of at most n items of the underlying stream. Read more

Take elements from this stream while the provided predicate resolves to true. Read more

Creates a new stream that will skip the n first items of the underlying stream. Read more

Skip elements from the underlying stream while the provided predicate resolves to true. Read more

Tests if every element of the stream matches a predicate. Read more

Tests if any element of the stream matches a predicate. Read more

Combine two streams into one by first returning all values from the first stream then all values from the second stream. Read more

A combinator that applies a function to every element in a stream producing a single, final value. Read more

Drain stream pushing all emitted values into a collection. Read more

Applies a per-item timeout to the passed stream. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type of successful values yielded by this future

The type of failures yielded by this future

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