pub enum Message {
    Text(String),
    Binary(Vec<u8, Global>),
    Ping(Vec<u8, Global>),
    Pong(Vec<u8, Global>),
    Close(Option<CloseFrame<'static>>),
    Frame(Frame),
}
Expand description

An enum representing the various forms of a WebSocket message.

Variants

Text(String)

A text WebSocket message

Binary(Vec<u8, Global>)

A binary WebSocket message

Ping(Vec<u8, Global>)

A ping message with the specified payload

The payload here must have a length less than 125 bytes

Pong(Vec<u8, Global>)

A pong message with the specified payload

The payload here must have a length less than 125 bytes

Close(Option<CloseFrame<'static>>)

A close message with the optional close frame.

Frame(Frame)

Raw frame. Note, that you’re not going to get this value while reading the message.

Implementations

Create a new text WebSocket message from a stringable.

Create a new binary WebSocket message by converting to Vec.

Indicates whether a message is a text message.

Indicates whether a message is a binary message.

Indicates whether a message is a ping message.

Indicates whether a message is a pong message.

Indicates whether a message ia s close message.

Get the length of the WebSocket message.

Returns true if the WebSocket message has no content. For example, if the other side of the connection sent an empty string.

Consume the WebSocket and return it as binary data.

Attempt to consume the WebSocket message and convert it to a String.

Attempt to get a &str from the WebSocket message, this will try to convert binary data to utf8.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.