Struct Channel

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

Available on crate feature threading only.

Blocking channel for sending data between threads.

Implementations

impl<T> Channel<T>

where T: Copy + Send,

pub const fn new() -> Channel<T>

pub fn send(&self, something: &T)

Send on the channel (blocking).

If there is no receiver waiting yet, the current thread is suspended until a receiver is ready.

Panics

Panics if this is called outside of a thread context.

pub fn try_send(&self, something: &T) -> bool

Try to send on the channel (non-blocking).

Returns true if a receiver was waiting and received the data, false otherwise.

pub fn recv(&self) -> T

Receive on the channel (blocking).

If there is no sender waiting yet, the current thread is suspended until a sender is ready.

Panics

Panics if this is called outside of a thread context.

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

Try to send on the channel (non-blocking).

Returns Some data if a sender was waiting and the data could be received, None otherwise.

Trait Implementations

impl<T> Default for Channel<T>

where T: Copy + Send,

fn default() -> Channel<T>

Returns the “default value” for a type.

impl<T> Sync for Channel<T>