Represents an owned WebSocket message.
OwnedMessage
s are generated when the user receives a message (since the data
has to be copied out of the network buffer anyway).
If you would like to create a message out of borrowed data to use for sending
please use the Message
struct (which contains a Cow
).
Note that OwnedMessage
and Message
can be converted into each other.
A message containing UTF-8 text data
A message containing binary data
A message which indicates closure of the WebSocket connection.
This message may or may not contain data.
A ping message - should be responded to with a pong message.
Usually the pong message will be sent with the same data as the
received ping message.
A pong message, sent in response to a Ping message, usually
containing the same data as the received ping message.
Checks if this message is a close message.
assert!(OwnedMessage::Close(None).is_close());
Checks if this message is a control message.
Control messages are either Close
, Ping
, or Pong
.
assert!(OwnedMessage::Ping(vec![]).is_control());
assert!(OwnedMessage::Pong(vec![]).is_control());
assert!(OwnedMessage::Close(None).is_control());
Checks if this message is a data message.
Data messages are either Text
or Binary
.
assert!(OwnedMessage::Text("1337".to_string()).is_data());
assert!(OwnedMessage::Binary(vec![]).is_data());
Checks if this message is a ping message.
Ping
messages can come at any time and usually generate a Pong
message
response.
assert!(OwnedMessage::Ping("ping".to_string().into_bytes()).is_ping());
Checks if this message is a pong message.
Pong
messages are usually sent only in response to Ping
messages.
assert!(OwnedMessage::Pong("pong".to_string().into_bytes()).is_pong());
Is this dataframe the final dataframe of the message?
What type of data does this dataframe contain?
Reserved bits of this dataframe
How long (in bytes) is this dataframe's payload
Write the payload to a writer
Takes the payload out into a vec
Get's the size of the entire dataframe in bytes, i.e. header and payload. Read more
Writes a DataFrame to a Writer.
Attempt to form a message from a series of data frames
Returns how many bytes this message will take up
Attempt to form a message from a series of data frames
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
Performs copy-assignment from source
. Read more
Formats the value using the given formatter. Read more
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
impl<T> Typeable for T where T: Any, | |
Get the TypeId
of this object.