Struct Frame

pub struct Frame<'buf> {
    pub head: Option<Head>,
    pub mask: Option<[u8; 4]>,
    pub payload: Option<&'buf [u8]>,
}

Expand description

A decoded Frame.

The optional values will be None if a decode was not complete, and did not decode the associated property. This allows you to inspect the parts that could be decoded, before reading more.

§Example

use ws_frame::Frame;
 
let buf = &[0b10000010, 0b00000001];
let mut f = Frame::empty();
 
if f.decode(buf).is_partial() {
    match f.head {
        Some(head) => assert_eq!([false; 3], head.rsv),
        None => {
            // read more and decode again
        }
    }
}

Fields§

§head: Option<Head>

The head section of a frame.

§mask: Option<[u8; 4]>

An optional mask key to apply over the payload.

§payload: Option<&'buf [u8]>

The payload section of a frame.

An empty payload is represented as Some(&[]).

Implementations§

impl<'buf> Frame<'buf>

pub const fn empty() -> Self

Creates a new Frame.

pub fn decode(&mut self, buf: &'buf [u8]) -> Status

Try to decode a buffer of bytes into this Frame.

Trait Implementations§

impl<'buf> Debug for Frame<'buf>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'buf> PartialEq for Frame<'buf>

fn eq(&self, other: &Frame<'buf>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'buf> StructuralPartialEq for Frame<'buf>

Auto Trait Implementations§

impl<'buf> Freeze for Frame<'buf>

impl<'buf> RefUnwindSafe for Frame<'buf>

impl<'buf> Send for Frame<'buf>

impl<'buf> Sync for Frame<'buf>

impl<'buf> Unpin for Frame<'buf>

impl<'buf> UnwindSafe for Frame<'buf>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

impl<T, U> TryInto<U> for T
where 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>

Performs the conversion.