[−][src]Struct websocket::dataframe::DataFrame
Represents a WebSocket data frame.
The data held in a DataFrame is never masked. Masking/unmasking is done when sending and receiving the data frame,
This DataFrame, unlike the standard Message implementation (which also
implements the DataFrame trait), owns its entire payload. This means that calls to payload
don't allocate extra memory (again unlike the default Message implementation).
Fields
finished: bool
Whether or no this constitutes the end of a message
reserved: [bool; 3]
The reserved portion of the data frame (RFC6455 5.2)
opcode: Opcode
The opcode associated with this data frame
data: Vec<u8>
The payload associated with this data frame
Methods
impl DataFrame
[src]
pub fn new(finished: bool, opcode: Opcode, data: Vec<u8>) -> DataFrame
[src]
Creates a new DataFrame.
pub fn read_dataframe_body(
header: DataFrameHeader,
body: Vec<u8>,
should_be_masked: bool
) -> WebSocketResult<Self>
[src]
header: DataFrameHeader,
body: Vec<u8>,
should_be_masked: bool
) -> WebSocketResult<Self>
Take the body and header of a dataframe and combine it into a single Dataframe struct. A websocket message can be made up of many individual dataframes, use the methods from the Message or OwnedMessage structs to take many of these and create a websocket message.
pub fn read_dataframe<R>(
reader: &mut R,
should_be_masked: bool
) -> WebSocketResult<Self> where
R: Read,
[src]
reader: &mut R,
should_be_masked: bool
) -> WebSocketResult<Self> where
R: Read,
Reads a DataFrame from a Reader.
Trait Implementations
impl DataFrame for DataFrame
[src]
fn is_last(&self) -> bool
[src]
fn opcode(&self) -> u8
[src]
fn reserved(&self) -> &[bool; 3]
[src]
fn size(&self) -> usize
[src]
fn write_payload(&self, socket: &mut dyn Write) -> WebSocketResult<()>
[src]
fn take_payload(self) -> Vec<u8>
[src]
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 dyn Write, mask: bool) -> WebSocketResult<()>
[src]
Writes a DataFrame to a Writer.
impl PartialEq<DataFrame> for DataFrame
[src]
impl Clone for DataFrame
[src]
fn clone(&self) -> DataFrame
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for DataFrame
[src]
Auto Trait Implementations
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Typeable for T where
T: Any,
T: Any,