Struct std::sync::mpsc::Receiver1.0.0 [] [src]

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

The receiving-half of Rust's channel type. This half can only be owned by one thread

Methods

impl<T> Receiver<T>
[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.

Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up.

This function will always block the current thread if there is no data available and it's possible for more data to be sent. Once a message is sent to the corresponding Sender, then this receiver will wake up and return that message.

If the corresponding Sender has disconnected, or it disconnects while this call is blocking, this call will wake up and return Err to indicate that no more messages can ever be received on this channel. However, since channels are buffered, messages sent before the disconnect will still be properly received.

Examples

use std::sync::mpsc;
use std::thread;

let (send, recv) = mpsc::channel();
let handle = thread::spawn(move || {
    send.send(1u8).unwrap();
});

handle.join().unwrap();

assert_eq!(Ok(1), recv.recv());Run

Buffering behavior:

use std::sync::mpsc;
use std::thread;
use std::sync::mpsc::RecvError;

let (send, recv) = mpsc::channel();
let handle = thread::spawn(move || {
    send.send(1u8).unwrap();
    send.send(2).unwrap();
    send.send(3).unwrap();
    drop(send);
});

// wait for the thread to join so we ensure the sender is dropped
handle.join().unwrap();

assert_eq!(Ok(1), recv.recv());
assert_eq!(Ok(2), recv.recv());
assert_eq!(Ok(3), recv.recv());
assert_eq!(Err(RecvError), recv.recv());Run

Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up, or if it waits more than timeout.

This function will always block the current thread if there is no data available and it's possible for more data to be sent. Once a message is sent to the corresponding Sender, then this receiver will wake up and return that message.

If the corresponding Sender has disconnected, or it disconnects while this call is blocking, this call will wake up and return Err to indicate that no more messages can ever be received on this channel. However, since channels are buffered, messages sent before the disconnect will still be properly received.

Examples

use std::sync::mpsc::{self, RecvTimeoutError};
use std::time::Duration;

let (send, recv) = mpsc::channel::<()>();

let timeout = Duration::from_millis(100);
assert_eq!(Err(RecvTimeoutError::Timeout), recv.recv_timeout(timeout));Run

Returns an iterator that will block waiting for messages, but never panic!. It will return None when the channel has hung up.

Unstable (receiver_try_iter #34931)

Returns an iterator that will attempt to yield all pending values. It will return None if there are no more pending values or if the channel has hung up. The iterator will never panic! or block the user by waiting for values.

Trait Implementations

impl<T: Send> Send for Receiver<T>
[src]

impl<T> !Sync for Receiver<T>
[src]

impl<'a, T> IntoIterator for &'a Receiver<T>
1.1.0
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

impl<T> IntoIterator for Receiver<T>
1.1.0
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

impl<T> Drop for Receiver<T>
[src]

A method called when the value goes out of scope. Read more

impl<T> Debug for Receiver<T>
1.7.0
[src]

Formats the value using the given formatter.