Struct twist::server::BaseFrameCodec

pub struct BaseFrameCodec { /* fields omitted */ }

Codec for encoding/decoding websocket base frames.

Methods

impl FrameCodec

fn set_client(&mut self, client: bool) -> &mut FrameCodec

Set the client flag.

fn set_reserved_bits(&mut self, reserved_bits: u8) -> &mut FrameCodec

Set the bits reserved by extensions (0-8 are valid values).

fn stdout(&mut self, logger: Logger) -> &mut FrameCodec

Add a stdout slog Logger to this protocol.

fn stderr(&mut self, logger: Logger) -> &mut FrameCodec

Add a stderr slog Logger to this protocol.

Trait Implementations

impl Clone for FrameCodec

fn clone(&self) -> FrameCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameCodec

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for FrameCodec

fn default() -> FrameCodec

Returns the "default value" for a type.

impl Decoder for FrameCodec

type Item = Frame

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(
    &mut self,
    buf: &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.

impl Encoder for FrameCodec

type Item = Frame

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors.

fn encode(&mut self, msg: Self::Item, buf: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.