Struct DeflateCodec

pub struct DeflateCodec<S: Read + Write> { /* private fields */ }

recv/send deflate message

Implementations

impl<S: Read + Write> DeflateCodec<S>

pub fn new( stream: S, frame_config: FrameConfig, pmd_config: Option<PMDConfig>, is_server: bool, ) -> Self

construct method

pub fn factory(req: Request<()>, stream: S) -> Result<Self, WsError>

used for server side to construct a new server

pub fn check_fn( key: String, resp: Response<()>, stream: S, ) -> Result<Self, WsError>

used for client side to construct a new client

pub fn stream_mut(&mut self) -> &mut S

get mutable underlying stream

pub fn receive(&mut self) -> Result<(SimplifiedHeader, &[u8]), WsError>

receive a message

pub fn send_owned_frame(&mut self, frame: OwnedFrame) -> Result<(), WsError>

send a read frame, this method will not check validation of frame and do not fragment

pub fn send(&mut self, code: OpCode, payload: &[u8]) -> Result<(), WsError>

send payload

will auto fragment before compression if auto_fragment_size > 0

pub fn text(&mut self, text: &str) -> Result<(), WsError>

helper function to send text message

pub fn binary(&mut self, data: &[u8]) -> Result<(), WsError>

helper function to send binary message

pub fn ping(&mut self, data: &[u8]) -> Result<(), WsError>

helper function to send ping message

pub fn pong(&mut self, data: &[u8]) -> Result<(), WsError>

helper function to send ping message

pub fn close(&mut self, code: u16, msg: &[u8]) -> Result<(), WsError>

helper method to send close message

pub fn flush(&mut self) -> Result<(), WsError>

flush stream to ensure all data are send

impl<R, W, S> DeflateCodec<S>

where R: Read, W: Write, S: Read + Write + Split<R = R, W = W>,

pub fn split(self) -> (DeflateRecv<R>, DeflateSend<W>)

split codec to recv and send parts