Struct TelnetCodec 

pub struct TelnetCodec {
    pub sga: bool,
    pub max_buffer_length: usize,
    pub buffer: Vec<u8>,
    pub message_mode: bool,
}

Implements a Tokio codec for the Telnet protocol, along with MUD-specific extension protocols such as GMCP.

You should never have to interact with this directly.

Fields

sga: bool

Whether or not the client has enabled the Suppress Go Ahead option.

max_buffer_length: usize

buffer: Vec<u8>

message_mode: bool

If this field is set to false, nectar will generate an event for each character instead of each message

Implementations

impl TelnetCodec

pub fn new(max_buffer_length: usize) -> Self

Trait Implementations

impl Debug for TelnetCodec

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

Formats the value using the given formatter.

impl Decoder for TelnetCodec

type Item = TelnetEvent

The type of decoded frames.

type Error = TelnetError

The type of unrecoverable frame decoding errors.

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

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, Self: Sized,

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 Encoder<TelnetEvent> for TelnetCodec

type Error = TelnetError

The type of encoding errors.

fn encode( &mut self, event: TelnetEvent, buffer: &mut BytesMut, ) -> Result<(), TelnetError>

Encodes a frame into the buffer provided.