Struct tokio::sync::mpsc::UnboundedReceiver[][src]

pub struct UnboundedReceiver<T> { /* fields omitted */ }
[]

Receive values from the associated UnboundedSender.

Instances are created by the unbounded_channel function.

Implementations

impl<T> UnboundedReceiver<T>[src][]

pub async fn recv(&mut self) -> Option<T>[src][]

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 (tx, mut rx) = mpsc::unbounded_channel();

    tokio::spawn(async move {
        tx.send("hello").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 (tx, mut rx) = mpsc::unbounded_channel();

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

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

pub fn try_recv(&mut self) -> Result<T, TryRecvError>[src][]

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).

pub fn close(&mut self)[src][]

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

impl<T> Debug for UnboundedReceiver<T>[src][+]

impl<T> Stream for UnboundedReceiver<T>[src][+]

type Item = T

Values yielded by the stream.

Auto Trait Implementations

impl<T> !RefUnwindSafe for UnboundedReceiver<T>

impl<T> Send for UnboundedReceiver<T> where
    T: Send

impl<T> Sync for UnboundedReceiver<T> where
    T: Send

impl<T> Unpin for UnboundedReceiver<T>

impl<T> !UnwindSafe for UnboundedReceiver<T>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src][+]

impl<T> Borrow<T> for T where
    T: ?Sized
[src][+]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src][+]

impl<T> From<T> for T[src][+]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src][+]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src][+]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src][+]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src][+]

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

The type returned in the event of a conversion error.

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

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future