CompressedProtocol

Struct CompressedProtocol 

Source
pub struct CompressedProtocol { /* private fields */ }
Expand description

WebSocket protocol handler with permessage-deflate compression (RFC 7692)

Implementations§

Source§

impl CompressedProtocol

Source

pub fn server( max_frame_size: usize, max_message_size: usize, config: DeflateConfig, ) -> Self

Create a new compressed protocol handler for server role

Source

pub fn client( max_frame_size: usize, max_message_size: usize, config: DeflateConfig, ) -> Self

Create a new compressed protocol handler for client role

Source

pub fn is_closed(&self) -> bool

Check if connection is closed

Source

pub fn is_closing(&self) -> bool

Check if we’re in the closing handshake

Source

pub fn process(&mut self, buf: &mut BytesMut) -> Result<Vec<Message>>

Process incoming data and return complete messages

Source

pub fn process_into( &mut self, buf: &mut BytesMut, messages: &mut Vec<Message>, ) -> Result<()>

Process incoming data into a reusable message buffer

Source

pub fn encode_message( &mut self, msg: &Message, buf: &mut BytesMut, ) -> Result<()>

Encode a message for sending with compression

Source

pub fn encode_pong(&mut self, ping_data: &[u8], buf: &mut BytesMut)

Encode a pong response for a ping

Source

pub fn encode_close_response(&mut self, buf: &mut BytesMut)

Encode a close response

Source

pub fn split( self, max_frame_size: usize, max_message_size: usize, ) -> (CompressedReaderProtocol, CompressedWriterProtocol)

Split the compressed protocol into separate reader and writer halves

This allows the encoder and decoder to be used independently for concurrent read/write operations.

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.