Struct ws_tool::frame::Header

source · [−]

pub struct Header(_);

Expand description

owned header buf

Implementations

source

impl Header

source

pub fn fin(&self) -> bool

get fin bit value

source

pub fn rsv1(&self) -> bool

get rsv1 bit value

source

pub fn rsv2(&self) -> bool

get rsv2 bit value

source

pub fn rsv3(&self) -> bool

get rsv3 bit value

source

pub fn opcode(&self) -> OpCode

return frame opcode

source

pub fn mask(&self) -> bool

get mask bit value

source

pub fn payload_len(&self) -> u64

return payload len

source

pub fn masking_key(&self) -> Option<[u8 ; 4]>

get frame mask key

source

pub fn payload_idx(&self) -> (usize, usize )

return (headerlen, the whole frame len)

source

pub fn set_fin(&mut self, val: bool)

set fin bit

source

pub fn set_rsv1(&mut self, val: bool)

set rsv1 bit

source

pub fn set_rsv2(&mut self, val: bool)

set rsv2 bit

source

pub fn set_rsv3(&mut self, val: bool)

set rsv3 bit

source

pub fn set_opcode(&mut self, code: OpCode)

set opcode

source

pub fn set_mask(&mut self, mask: bool)

NOTE if change mask bit after setting payload you need to set payload again to adjust data frame

source

pub fn set_payload_len(&mut self, len: u64) -> usize

set header payload lens

source

pub fn set_masking_key(&mut self, key: [u8 ; 4])

key header mask key

source

pub fn auto_mask(&mut self) -> Option<[u8 ; 4]>

auto generate mask key and apply it

source

pub fn config(
    fin: bool,
    rsv1: bool,
    rsv2: bool,
    rsv3: bool,
    opcode: OpCode,
    mask: bool,
    payload_len: u64,
    buf: &mut BytesMut
)

config mut buf as a valid header

NOTE this operation will override buf content, and try to extend if there is no enough len

source

pub fn new<M: Into<Option<[u8 ; 4]>>>(
 fin: bool,
 rsv1: bool,
 rsv2: bool,
 rsv3: bool,
 mask_key: M,
 opcode: OpCode,
 payload_len: u64
) -> Self

construct new header

source

pub fn view(&self) -> HeaderView<'_>

return read only header view

source

pub fn view_mut(&mut self) -> HeaderViewMut<'_>

return mutable header view

Trait Implementations

source

impl Clone for Header

source

fn clone(&self) -> Header

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 Header

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for Header

impl Send for Header

impl Sync for Header

impl Unpin for Header

impl UnwindSafe for Header

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> Same<T> for T

type Output = T

Should always be Self

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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 ws_tool::frame::Header

Implementations

impl Header

pub fn fin(&self) -> bool

pub fn rsv1(&self) -> bool

pub fn rsv2(&self) -> bool

pub fn rsv3(&self) -> bool

pub fn opcode(&self) -> OpCode

pub fn mask(&self) -> bool

pub fn payload_len(&self) -> u64

pub fn masking_key(&self) -> Option<[u8; 4]>

pub fn payload_idx(&self) -> (usize, usize)

pub fn set_fin(&mut self, val: bool)

pub fn set_rsv1(&mut self, val: bool)

pub fn set_rsv2(&mut self, val: bool)

pub fn set_rsv3(&mut self, val: bool)

pub fn set_opcode(&mut self, code: OpCode)

pub fn set_mask(&mut self, mask: bool)

pub fn set_payload_len(&mut self, len: u64) -> usize

pub fn set_masking_key(&mut self, key: [u8; 4])

pub fn auto_mask(&mut self) -> Option<[u8; 4]>

pub fn config( fin: bool, rsv1: bool, rsv2: bool, rsv3: bool, opcode: OpCode, mask: bool, payload_len: u64, buf: &mut BytesMut)

pub fn new<M: Into<Option<[u8; 4]>>>( fin: bool, rsv1: bool, rsv2: bool, rsv3: bool, mask_key: M, opcode: OpCode, payload_len: u64) -> Self

pub fn view(&self) -> HeaderView<'_>

pub fn view_mut(&mut self) -> HeaderViewMut<'_>

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

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

impl Debug for Header

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

Auto Trait Implementations

impl RefUnwindSafe for Header

impl Send for Header

impl Sync for Header

impl Unpin for Header

impl UnwindSafe for Header

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> Same<T> for T

type Output = T

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 masking_key(&self) -> Option<[u8 ; 4]>

pub fn payload_idx(&self) -> (usize, usize )

pub fn set_masking_key(&mut self, key: [u8 ; 4])

pub fn auto_mask(&mut self) -> Option<[u8 ; 4]>

pub fn config(
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
opcode: OpCode,
mask: bool,
payload_len: u64,
buf: &mut BytesMut
)

pub fn new<M: Into<Option<[u8 ; 4]>>>(
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
mask_key: M,
opcode: OpCode,
payload_len: u64
) -> 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>,