Struct websocket_codec::protocol::FrameHeader

source · [−]

pub struct FrameHeader { /* private fields */ }

Expand description

Describes an individual frame within a WebSocket message at a low level.

The frame header is a lower level detail of the WebSocket protocol. At the application level, use Message structs and the MessageCodec.

Implementations

source

impl FrameHeader

source

pub fn new(
 fin: bool,
 rsv: u8,
 opcode: u8,
 mask: Option<Mask>,
 data_len: DataLength
) -> Self

Returns a FrameHeader struct.

source

pub fn fin(&self) -> bool

Returns the WebSocket FIN bit, which indicates that this is the last frame in the message.

source

pub fn rsv(&self) -> u8

Returns the WebSocket RSV1, RSV2 and RSV3 bits.

The RSV bits may be used by extensions to the WebSocket protocol not exposed by this crate.

source

pub fn opcode(&self) -> u8

Returns the WebSocket opcode, which defines the interpretation of the frame payload data.

source

pub fn mask(&self) -> Option<Mask>

Returns the frame’s mask.

source

pub fn data_len(&self) -> DataLength

Returns the length of the payload data that follows this header.

source

pub fn header_len(&self) -> usize

Returns the total length of the frame header.

The frame header is between 2 bytes and 10 bytes in length, depending on the presence of a mask and the length of the payload data.

Trait Implementations

source

impl Clone for FrameHeader

source

fn clone(&self) -> FrameHeader

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for FrameHeader

source

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

Formats the value using the given formatter. Read more

source

impl<'a> Encoder<&'a FrameHeader> for FrameHeaderCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

The type of encoding errors. Read more

source

fn encode(&mut self, item: &'a FrameHeader, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided. Read more

source

impl Encoder<FrameHeader> for FrameHeaderCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

The type of encoding errors. Read more

source

fn encode(&mut self, item: FrameHeader, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided. Read more

source

impl PartialEq<FrameHeader> for FrameHeader

source

fn eq(&self, other: &FrameHeader) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl StructuralPartialEq for FrameHeader

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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct websocket_codec::protocol::FrameHeader

Implementations

impl FrameHeader

pub fn new( fin: bool, rsv: u8, opcode: u8, mask: Option<Mask>, data_len: DataLength) -> Self

pub fn fin(&self) -> bool

pub fn rsv(&self) -> u8

pub fn opcode(&self) -> u8

pub fn mask(&self) -> Option<Mask>

pub fn data_len(&self) -> DataLength

pub fn header_len(&self) -> usize

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

fn clone_from(&mut self, source: &Self)

impl Debug for FrameHeader

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

impl<'a> Encoder<&'a FrameHeader> for FrameHeaderCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

fn encode(&mut self, item: &'a FrameHeader, dst: &mut BytesMut) -> Result<()>

impl Encoder<FrameHeader> for FrameHeaderCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

fn encode(&mut self, item: FrameHeader, dst: &mut BytesMut) -> Result<()>

impl PartialEq<FrameHeader> for FrameHeader

fn eq(&self, other: &FrameHeader) -> bool

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

impl StructuralPartialEq for FrameHeader

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,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new(
fin: bool,
rsv: u8,
opcode: u8,
mask: Option<Mask>,
data_len: DataLength
) -> Self

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,