Struct Receiver

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

A receiver for values sent by a Sender.

Implementations

impl<T> Receiver<T>

where T: Send + 'static,

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

Returns the next value, blocking the current thread until one is available.

Returns None if there are no Senders still connected to this channel.

pub fn try_receive(&self) -> Result<T, TryReceiveError>

Returns the next value if possible, otherwise returning an error describing why a value was unable to be received.

This function will not block the current thread.

pub fn on_receive<Map>(self, on_receive: Map) -> CallbackHandle

where Map: FnMut(T) + Send + 'static,

Invokes on_receive each time a value is sent to this channel.

This function assumes on_receive may block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing.

pub fn on_receive_try<Map>(self, on_receive: Map) -> CallbackHandle

where Map: FnMut(T) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes on_receive each time a value is sent to this channel. Once an error is returned, this callback will be removed from the channel.

This function assumes on_receive may block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing.

Once the last callback associated with a channel is removed, Senders will begin returning disconnected errors.

pub fn on_receive_nonblocking<Map>(self, on_receive: Map) -> CallbackHandle

where Map: FnMut(T) + Send + 'static,

Invokes on_receive each time a value is sent to this channel.

This function assumes on_receive will not block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing in a shared environment.

pub fn on_receive_nonblocking_try<Map>(self, on_receive: Map) -> CallbackHandle

where Map: FnMut(T) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes on_receive each time a value is sent to this channel. Once an error is returned, this callback will be removed from the channel.

This function assumes on_receive will not block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing in a shared environment.

Once the last callback associated with a channel is removed, Senders will begin returning disconnected errors.

pub fn on_receive_async<Map, Fut>(self, on_receive: Map) -> CallbackHandle

where Map: FnMut(T) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Invokes on_receive each time a value is sent to this channel.

pub fn on_receive_async_try<Map, Fut>(self, on_receive: Map) -> CallbackHandle

where Map: FnMut(T) -> Fut + Send + 'static, Fut: Future<Output = Result<(), CallbackDisconnected>> + Send + 'static,

Invokes on_receive each time a value is sent to this channel. The returned future will then be awaited. Once an error is returned, this callback will be removed from the channel.

Once the last callback associated with a channel is removed, Senders will begin returning disconnected errors.

Trait Implementations

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Future for &Receiver<T>

where T: Unpin + Send + 'static,

type Output = Option<T>

The type of value produced on completion.

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

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

impl<T> Unwrapped<T> for Receiver<Option<T>>

where T: Send + 'static,

type Value<'a> = T

The value type provided to the for each functions.

fn unwrapped_or_else(self, initial: impl FnOnce() -> T) -> Dynamic<T>

Returns a dynamic that is updated with the unwrapped contents of thie source.

fn for_each_unwrapped_try<ForEach>(self, for_each: ForEach) -> CallbackHandle

where ForEach: for<'a> FnMut(Self::Value<'a>) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes for_each when self is updated with a value that can be unwrapped.

fn unwrapped(self) -> Dynamic<T>

where T: Default,

Returns a dynamic that is updated with the unwrapped contents of thie source.

fn for_each_unwrapped<ForEach>(self, for_each: ForEach) -> CallbackHandle

where ForEach: for<'a> FnMut(Self::Value<'a>) + Send + 'static,

Invokes for_each when self is updated with a value that can be unwrapped.

impl<T, E> Unwrapped<T> for Receiver<Result<T, E>>

where T: Send + 'static, E: Send + 'static,

type Value<'a> = T

The value type provided to the for each functions.

fn unwrapped_or_else(self, initial: impl FnOnce() -> T) -> Dynamic<T>

Returns a dynamic that is updated with the unwrapped contents of thie source.

fn for_each_unwrapped_try<ForEach>(self, for_each: ForEach) -> CallbackHandle

where ForEach: for<'a> FnMut(Self::Value<'a>) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes for_each when self is updated with a value that can be unwrapped.

fn unwrapped(self) -> Dynamic<T>

where T: Default,

Returns a dynamic that is updated with the unwrapped contents of thie source.

fn for_each_unwrapped<ForEach>(self, for_each: ForEach) -> CallbackHandle

where ForEach: for<'a> FnMut(Self::Value<'a>) + Send + 'static,

Invokes for_each when self is updated with a value that can be unwrapped.