Struct twilight_gateway::MessageSender

pub struct MessageSender { /* private fields */ }

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

Unlike the methods on Shard, messages queued up through this are conditionally sent when not ratelimited and identified (except for close frames which are sent as long as the shard is connected to the Websocket).

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<(), SendError>

Send a command to the associated shard.

Errors

Returns a SendErrorType::Sending error type if the channel is closed.

Returns a SendErrorType::Serializing error type if the provided command failed to serialize.

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

Send a JSON encoded gateway event to the associated shard.

Errors

Returns a SendErrorType::Sending error type if the channel is closed.

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

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 SendErrorType::Sending 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.