Struct ws_tool::codec::WebSocketStringCodec

pub struct WebSocketStringCodec {
    pub frame_codec: WebSocketFrameCodec,
    pub validate_utf8: bool,
}

Fields

frame_codec: WebSocketFrameCodec

validate_utf8: bool

Trait Implementations

impl Clone for WebSocketStringCodec

fn clone(&self) -> WebSocketStringCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketStringCodec

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

Formats the value using the given formatter.

impl Decoder for WebSocketStringCodec

type Item = (OpCode, String)

The type of decoded frames.

type Error = WsError

The type of unrecoverable frame decoding errors.

fn decode(
    &mut self,
    src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self> where
    T: AsyncRead + AsyncWrite, 

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for WebSocketStringCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<String> for WebSocketStringCodec

type Error = WsError

The type of encoding errors.

fn encode(
    &mut self,
    item: String,
    dst: &mut BytesMut
) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.