Struct Channel

pub struct Channel<T = (), U: ?Sized = ()>(/* private fields */);

An MPMC channel with both send and receive capabilities

Enable the futures_core_3 feature for Channel to implement Stream (generic T must be Option<Item>).

Enable the event_iterator feature for Channel to implement EventIterator.

Implementations

impl<T> Channel<T>

pub fn new() -> Self

Create a new channel.

impl<T, U> Channel<T, U>

pub fn with(user_data: U) -> Self

Create a new channel with associated data.

impl<T, U: ?Sized> Channel<T, U>

pub async fn send(&self, message: T)

Send a message on this channel.

pub async fn recv(&self) -> T

Receive a message from this channel.

Trait Implementations

impl<T, U: ?Sized> Clone for Channel<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, U: ?Sized> Debug for Channel<T, U>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, U: ?Sized + Default> Default for Channel<T, U>

fn default() -> Self

Returns the “default value” for a type.

impl<T, U: ?Sized> Deref for Channel<T, U>

type Target = U

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, U: ?Sized> Drop for Channel<T, U>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, U: ?Sized> EventIterator for Channel<T, U>

type Event<'me> = T where Self: 'me

The type of the events being iterated over

fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<T>>

Attempt to pull out the next event of this event iterator, registering the current task for wakeup if the value is not yet available, and returning None if the event iterator is exhausted.

fn next<'a>(self: Pin<&'a mut Self>) -> Next<'a, Self>

Create a future that resolves to the next event in the event iterator.

fn next_unpinned(&mut self) -> Next<'_, Self>

where Self: Unpin,

Create a future that resolves to the next event in the event iterator.

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

Return the bounds on the remaining length of the event iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized + EventIterator, F: for<'me> FnMut(Self::Event<'me>) -> B,

Takes a closure and creates an event iterator which calls that closure on each event.

impl<T, U: ?Sized> From<Arc<Queue<T, U>>> for Channel<T, U>

fn from(inner: Arc<Queue<T, U>>) -> Self

Converts to this type from the input type.

impl<T, U: ?Sized> From<Channel<T, U>> for Arc<Queue<T, U>>

fn from(channel: Channel<T, U>) -> Self

Converts to this type from the input type.

impl<T, U: ?Sized> Future for Channel<T, U>

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T, U: ?Sized> Stream for Channel<Option<T>, U>

type Item = T

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<T>>

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.

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

Returns the bounds on the remaining length of the stream.