Struct StringCodec

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

recv/send text message

Implementations

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

pub fn new(stream: S) -> Self

construct method

pub fn new_with(stream: S, config: FrameConfig, validate_utf8: bool) -> Self

construct with config

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

get mutable underlying stream

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 to client side to construct a new client

pub fn receive_raw(&mut self) -> Result<Message<Cow<'_, [u8]>>, WsError>

in case of ping/pong/close contain non utf-8 string, use this api to receive raw message

for close frame with body, first two bytes of string are close reason

pub fn receive(&mut self) -> Result<Message<Cow<'_, str>>, WsError>

for close frame with body, first two bytes of string are close reason

pub fn ping<'a>(&mut self, msg: &'a str) -> Result<(), WsError>

helper method to send ping message

pub fn pong<'a>(&mut self, msg: &'a str) -> Result<(), WsError>

helper method to send pong message

pub fn close<'a>(&mut self, code: u16, msg: &'a str) -> Result<(), WsError>

helper method to send close message

pub fn send<'a, T: Into<Message<Cow<'a, str>>>>( &mut self, msg: T, ) -> Result<(), WsError>

send text message

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

flush underlying stream

impl<R, W, S> StringCodec<S>

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

pub fn split(self) -> (StringRecv<R>, StringSend<W>)

split codec to recv and send parts