Enum twilight_gateway::shard::raw_message::Message

#[non_exhaustive]pub enum Message {
    Binary(Vec<u8>),
    Close(Option<CloseFrame<'static>>),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Text(String),
}

Message to send over the connection to the remote.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Binary(Vec<u8>)

Binary websocket message.

Close(Option<CloseFrame<'static>>)

Close message with an optional frame including information about the reason for the close.

Ping(Vec<u8>)

Ping message with a payload.

The payload must have a length less than 125 bytes.

Pong(Vec<u8>)

Pong message with a payload.

The payload must have a length less than 125 bytes.

Text(String)

Text websocket message.

Trait Implementations

impl Clone for Message

pub fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Eq for Message

impl PartialEq<Message> for Message

pub fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Message) -> bool

This method tests for !=.

impl Sink<Message> for ShardSink

type Error = SendError

The type of value produced by the sink when an error occurs.

pub fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

pub fn start_send(
    mut self: Pin<&mut Self>,
    msg: Message
) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

pub fn poll_flush(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

pub fn poll_close(
    mut self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl Sink<Message> for &ShardSink

type Error = SendError

The type of value produced by the sink when an error occurs.

pub fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

pub fn start_send(self: Pin<&mut Self>, msg: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

pub fn poll_flush(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

pub fn poll_close(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl StructuralEq for Message

impl StructuralPartialEq for Message