Struct ws_tool::codec::WebSocketFrameCodec

pub struct WebSocketFrameCodec {
    pub config: FrameConfig,
    pub fragmented: bool,
    pub fragmented_data: BytesMut,
    pub fragmented_type: OpCode,
}

Fields

config: FrameConfig

fragmented: bool

fragmented_data: BytesMut

fragmented_type: OpCode

Trait Implementations

impl Clone for WebSocketFrameCodec

fn clone(&self) -> WebSocketFrameCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketFrameCodec

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

Formats the value using the given formatter.

impl Decoder for WebSocketFrameCodec

type Item = Frame

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 WebSocketFrameCodec

fn default() -> WebSocketFrameCodec

Returns the “default value” for a type.

impl Encoder<Frame> for WebSocketFrameCodec

type Error = WsError

The type of encoding errors.

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

Encodes a frame into the buffer provided.