Struct CommandSender

pub struct CommandSender(pub UnboundedSender<CommandQueue>);

Resource used to send command queues, allowing for async operations.

Tuple Fields

0: UnboundedSender<CommandQueue>

Methods from Deref<Target = UnboundedSender<CommandQueue>>

pub fn poll_ready(&self, _: &mut Context<'_>) -> Poll<Result<(), SendError>>

Check if the channel is ready to receive a message.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close_channel(&self)

Closes this channel from the sender side, preventing any new messages.

pub fn disconnect(&mut self)

Disconnects this sender from the channel, closing it if there are no more senders left.

pub fn start_send(&mut self, msg: T) -> Result<(), SendError>

Send a message on the channel.

This method should only be called after poll_ready has been used to verify that the channel is ready to receive a message.

pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>

Sends a message along this channel.

This is an unbounded sender, so this function differs from Sink::send by ensuring the return type reflects that the channel is always ready to receive messages.

pub fn same_receiver(&self, other: &UnboundedSender<T>) -> bool

Returns whether the senders send to the same receiver.

pub fn is_connected_to(&self, receiver: &UnboundedReceiver<T>) -> bool

Returns whether the sender send to this receiver.

pub fn hash_receiver<H>(&self, hasher: &mut H)

where H: Hasher,

Hashes the receiver into the provided hasher

pub fn len(&self) -> usize

Return the number of messages in the queue or 0 if channel is disconnected.

pub fn is_empty(&self) -> bool

Return false is channel has no queued messages, true otherwise.

Trait Implementations

impl AsMut<UnboundedSender<CommandQueue>> for CommandSender

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

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

impl AsRef<UnboundedSender<CommandQueue>> for CommandSender

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

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

impl Clone for CommandSender

fn clone(&self) -> CommandSender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSender

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

Formats the value using the given formatter.

impl DerefMut for CommandSender

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

Mutably dereferences the value.

impl Deref for CommandSender

type Target = UnboundedSender<CommandQueue>

The resulting type after dereferencing.

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

Dereferences the value.

impl Resource for CommandSender

where Self: Send + Sync + 'static,