Struct CommandReceiver

pub struct CommandReceiver(pub UnboundedReceiver<CommandQueue>);

Resource used to receive command queues. These command queues are handled with handle_tasks.

Tuple Fields

0: UnboundedReceiver<CommandQueue>

Methods from Deref<Target = UnboundedReceiver<CommandQueue>>

pub fn close(&mut self)

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.

pub fn try_next(&mut self) -> Result<Option<T>, TryRecvError>

Tries to receive the next message without notifying a context if empty.

It is not recommended to call this function from inside of a future, only when you’ve otherwise arranged to be notified when the channel is no longer empty.

This function returns:

• Ok(Some(t)) when message is fetched
• Ok(None) when channel is closed and no messages left in the queue
• Err(e) when there are no messages available, but channel is not yet closed

Trait Implementations

impl AsMut<UnboundedReceiver<CommandQueue>> for CommandReceiver

fn as_mut(&mut self) -> &mut UnboundedReceiver<CommandQueue>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<UnboundedReceiver<CommandQueue>> for CommandReceiver

fn as_ref(&self) -> &UnboundedReceiver<CommandQueue>

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for CommandReceiver

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

Formats the value using the given formatter.

impl DerefMut for CommandReceiver

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Deref for CommandReceiver

type Target = UnboundedReceiver<CommandQueue>

The resulting type after dereferencing.

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

Dereferences the value.

impl Resource for CommandReceiver

where Self: Send + Sync + 'static,