Struct soketto::base::Codec

source · [−]

pub struct Codec { /* private fields */ }

Expand description

Codec for encoding/decoding websocket base frames.

Implementations

source

impl Codec

source

pub fn new() -> Self

Create a new base frame codec.

The codec will support decoding payload lengths up to 256 MiB (use set_max_data_size to change this value).

source

pub fn max_data_size(&self) -> usize

Get the configured maximum payload length.

source

pub fn set_max_data_size(&mut self, size: usize) -> &mut Self

Limit the maximum size of payload data to size bytes.

source

pub fn reserved_bits(&self) -> (bool, bool, bool )

The reserved bits currently configured.

source

pub fn add_reserved_bits(&mut self, bits: (bool, bool, bool )) -> &mut Self

Add to the reserved bits in use.

source

pub fn clear_reserved_bits(&mut self)

Reset the reserved bits.

source

pub fn decode_header(
&self,
bytes: &[u8 ]
) -> Result<Parsing<Header, usize>, Error>

Decode a websocket frame header.

source

pub fn encode_header(&mut self, header: &Header) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Encode a websocket frame header.

source

pub fn apply_mask(header: &Header, data: &mut [u8 ])

Use the given header’s mask and apply it to the data.

Trait Implementations

source

impl Clone for Codec

source

fn clone(&self) -> Codec

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 Codec

source

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

Formats the value using the given formatter. Read more

source

impl Default for Codec

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Codec

impl Send for Codec

impl Sync for Codec

impl Unpin for Codec

impl UnwindSafe for Codec

Blanket Implementations

source

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

source

pub 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

pub 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

pub 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

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

pub fn to_owned(&self) -> T

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

source

pub 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

pub 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

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

Performs the conversion.

source

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

source

Struct soketto::base::Codec

Implementations

impl Codec

pub fn new() -> Self

pub fn max_data_size(&self) -> usize

pub fn set_max_data_size(&mut self, size: usize) -> &mut Self

pub fn reserved_bits(&self) -> (bool, bool, bool)

pub fn add_reserved_bits(&mut self, bits: (bool, bool, bool)) -> &mut Self

pub fn clear_reserved_bits(&mut self)

pub fn decode_header( &self, bytes: &[u8]) -> Result<Parsing<Header, usize>, Error>

pub fn encode_header(&mut self, header: &Header) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn apply_mask(header: &Header, data: &mut [u8])

Trait Implementations

impl Clone for Codec

fn clone(&self) -> Codec

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

impl Debug for Codec

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

impl Default for Codec

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for Codec

impl Send for Codec

impl Sync for Codec

impl Unpin for Codec

impl UnwindSafe for Codec

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

pub 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

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

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

pub fn vzip(self) -> V

pub fn reserved_bits(&self) -> (bool, bool, bool )

pub fn add_reserved_bits(&mut self, bits: (bool, bool, bool )) -> &mut Self

pub fn decode_header(
&self,
bytes: &[u8 ]
) -> Result<Parsing<Header, usize>, Error>

pub fn encode_header(&mut self, header: &Header) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn apply_mask(header: &Header, data: &mut [u8 ])

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>,