Struct evzht9h3nznqzwl::message::Message
[−]
[src]
pub struct Message<'a> { pub opcode: Type, pub cd_status_code: Option<u16>, pub payload: Cow<'a, [u8]>, }
Represents a WebSocket message.
This message also has the ability to not own its payload, and stores its entire payload in
chunks that get written in order when the message gets sent. This makes the write_payload
allocate less memory than the payload
method (which creates a new buffer every time).
Incidentally this (the default implementation of Message) implements the DataFrame trait because this message just gets sent as one single DataFrame.
Fields
opcode: Type
Type of WebSocket message
cd_status_code: Option<u16>
Optional status code to send when closing a connection. (only used if this message is of Type::Close)
payload: Cow<'a, [u8]>
Main payload
Methods
impl<'a> Message<'a>
[src]
fn text<S>(data: S) -> Self where
S: Into<Cow<'a, str>>,
[src]
S: Into<Cow<'a, str>>,
Create a new WebSocket message with text data
fn binary<B>(data: B) -> Self where
B: IntoCowBytes<'a>,
[src]
B: IntoCowBytes<'a>,
Create a new WebSocket message with binary data
fn close() -> Self
[src]
Create a new WebSocket message that signals the end of a WebSocket connection, although messages can still be sent after sending this
fn close_because<S>(code: u16, reason: S) -> Self where
S: Into<Cow<'a, str>>,
[src]
S: Into<Cow<'a, str>>,
Create a new WebSocket message that signals the end of a WebSocket connection and provide a text reason and a status code for why. Messages can still be sent after sending this message.
fn ping<P>(data: P) -> Self where
P: IntoCowBytes<'a>,
[src]
P: IntoCowBytes<'a>,
Create a ping WebSocket message, a pong is usually sent back after sending this with the same data
fn pong<P>(data: P) -> Self where
P: IntoCowBytes<'a>,
[src]
P: IntoCowBytes<'a>,
Create a pong WebSocket message, usually a response to a ping message
fn into_pong(&mut self) -> Result<(), ()>
[src]
Convert a ping message to a pong, keeping the data. This will fail if the original message is not a ping.
Trait Implementations
impl<'a> Eq for Message<'a>
[src]
impl<'a> PartialEq for Message<'a>
[src]
fn eq(&self, __arg_0: &Message<'a>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Message<'a>) -> bool
[src]
This method tests for !=
.
impl<'a> Clone for Message<'a>
[src]
fn clone(&self) -> Message<'a>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<'a> Debug for Message<'a>
[src]
impl<'a> DataFrame for Message<'a>
[src]
fn is_last(&self) -> bool
[src]
Is this dataframe the final dataframe of the message?
fn opcode(&self) -> u8
[src]
What type of data does this dataframe contain?
fn reserved(&self) -> &[bool; 3]
[src]
Reserved bits of this dataframe
fn size(&self) -> usize
[src]
How long (in bytes) is this dataframe's payload
fn write_payload(&self, socket: &mut Write) -> WebSocketResult<()>
[src]
Write the payload to a writer
fn take_payload(self) -> Vec<u8>
[src]
Takes the payload out into a vec
fn frame_size(&self, masked: bool) -> usize
[src]
Get's the size of the entire dataframe in bytes, i.e. header and payload. Read more
fn write_to(&self, writer: &mut Write, mask: bool) -> WebSocketResult<()>
[src]
Writes a DataFrame to a Writer.
impl<'a> Message for Message<'a>
[src]
fn serialize(&self, writer: &mut Write, masked: bool) -> WebSocketResult<()>
[src]
Attempt to form a message from a series of data frames
fn message_size(&self, masked: bool) -> usize
[src]
Returns how many bytes this message will take up
fn from_dataframes<D>(frames: Vec<D>) -> WebSocketResult<Self> where
D: DataFrameTrait,
[src]
D: DataFrameTrait,
Attempt to form a message from a series of data frames
impl<'m> From<OwnedMessage> for Message<'m>
[src]
fn from(message: OwnedMessage) -> Self
[src]
Performs the conversion.