Struct MessageSender

pub struct MessageSender { /* private fields */ }

Channel to send messages over a Shard to the Discord gateway.

Implementations

impl MessageSender

pub fn is_closed(&self) -> bool

Whether the channel is closed.

The channel will only be closed if the associated shard has been dropped.

pub fn command(&self, command: &impl Command) -> Result<(), ChannelError>

Send a command to the associated shard.

Errors

Returns a ChannelErrorType::Closed error type if the channel is closed.

pub fn send(&self, json: String) -> Result<(), ChannelError>

Send a JSON encoded gateway event to the associated shard.

Errors

Returns a ChannelErrorType::Closed error type if the channel is closed.

pub fn close( &self, close_frame: CloseFrame<'static>, ) -> Result<(), ChannelError>

Send a Websocket close frame to the associated shard.

Subsequent calls may be queued up to be sent once the shard’s reestablished a Websocket connection or ignored if the queue is full. The internal queue capacity is currently 1.

See the Shard::close docs for further information.

Errors

Returns a ChannelErrorType::Closed error type if the channel is closed.

Trait Implementations

impl Clone for MessageSender

fn clone(&self) -> MessageSender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageSender

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

Formats the value using the given formatter.