Struct soketto::extension::deflate::Deflate

pub struct Deflate { /* fields omitted */ }

The deflate extension type.

The extension does currently not support max. window bits other than the default, which is 15 and will ask for no context takeover during handshake.

Implementations

impl Deflate

pub fn new(mode: Mode) -> Self

Create a new deflate extension either on client or server side.

pub fn set_max_server_window_bits(&mut self, max: u8)

Set the server’s max. window bits.

The value must be within 9 ..= 15. The extension must be in client mode.

By including this parameter, a client limits the LZ77 sliding window size that the server will use to compress messages. A server accepts by including the “server_max_window_bits” extension parameter in the response with the same or smaller value as the offer.

pub fn set_max_client_window_bits(&mut self, max: u8)

Set the client’s max. window bits.

The value must be within 9 ..= 15. The extension must be in client mode.

The parameter informs the server that even if it doesn’t include the “client_max_window_bits” extension parameter in the response with a value greater than the one in the negotiation offer or if it doesn’t include the extension parameter at all, the client is not going to use an LZ77 sliding window size greater than one given here. The server may also respond with a smaller value which allows the client to reduce its sliding window even more.

Trait Implementations

impl Debug for Deflate

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

Formats the value using the given formatter.

impl Extension for Deflate

fn name(&self) -> &str

The name of this extension.

fn is_enabled(&self) -> bool

Is this extension enabled?

fn params(&self) -> &[Param<'_>]

The parameters this extension wants to send for negotiation.

fn configure(&mut self, params: &[Param<'_>]) -> Result<(), BoxedError>

Configure this extension with the parameters received from negotiation.

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

The reserved bits this extension uses.

fn decode(
    &mut self,
    header: &mut Header,
    data: &mut Vec<u8>
) -> Result<(), BoxedError>

Decode a frame.

fn encode(
    &mut self,
    header: &mut Header,
    data: &mut Storage<'_>
) -> Result<(), BoxedError>

Encode a frame, given as frame header and payload data.