Trait webparse::ws::DataFrameable

pub trait DataFrameable {
    // Required methods
    fn is_last(&self) -> bool;
    fn opcode(&self) -> u8;
    fn reserved(&self) -> &[bool; 3];
    fn size(&self) -> usize;
    fn write_payload(&self, socket: &mut dyn BufMut) -> WebResult<()>;
    fn take_payload(self) -> Vec<u8> ;

    // Provided methods
    fn frame_size(&self, masked: bool) -> usize { ... }
    fn write_to(
        &self,
        writer: &mut dyn BufMut,
        masking_key: Option<[u8; 4]>
    ) -> WebResult<usize> { ... }
}

Required Methods

fn is_last(&self) -> bool

Is this dataframe the final dataframe of the message?

fn opcode(&self) -> u8

What type of data does this dataframe contain?

fn reserved(&self) -> &[bool; 3]

Reserved bits of this dataframe

fn size(&self) -> usize

How long (in bytes) is this dataframe’s payload

fn write_payload(&self, socket: &mut dyn BufMut) -> WebResult<()>

Write the payload to a writer

fn take_payload(self) -> Vec<u8>

Takes the payload out into a vec

Provided Methods

fn frame_size(&self, masked: bool) -> usize

Get’s the size of the entire dataframe in bytes, i.e. header and payload.

fn write_to( &self, writer: &mut dyn BufMut, masking_key: Option<[u8; 4]> ) -> WebResult<usize>

Writes a DataFrame to a Writer.

Implementors

impl DataFrameable for OwnedMessage

impl DataFrameable for DataFrame

impl<'a> DataFrameable for Message<'a>