Struct tungstenite::protocol::frame::FrameHeader[][src]

pub struct FrameHeader {
    pub is_final: bool,
    pub rsv1: bool,
    pub rsv2: bool,
    pub rsv3: bool,
    pub opcode: OpCode,
    // some fields omitted
}

A struct representing a WebSocket frame header.

Fields

is_final: bool

Indicates that the frame is the last one of a possibly fragmented message.

rsv1: bool

Reserved for protocol extensions.

rsv2: bool

Reserved for protocol extensions.

rsv3: bool

Reserved for protocol extensions.

opcode: OpCode

WebSocket protocol opcode.

Implementations

impl FrameHeader[src]

pub fn parse(
    cursor: &mut Cursor<impl AsRef<[u8]>>
) -> Result<Option<(Self, u64)>>
[src]

Parse a header from an input stream. Returns None if insufficient data and does not consume anything in this case. Payload size is returned along with the header.

pub fn len(&self, length: u64) -> usize[src]

Get the size of the header formatted with given payload length.

pub fn format(&self, length: u64, output: &mut impl Write) -> Result<()>[src]

Format a header for given payload size.

Trait Implementations

impl Clone for FrameHeader[src]

impl Debug for FrameHeader[src]

impl Default for FrameHeader[src]

Auto Trait Implementations

impl RefUnwindSafe for FrameHeader

impl Send for FrameHeader

impl Sync for FrameHeader

impl Unpin for FrameHeader

impl UnwindSafe for FrameHeader

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]