Struct libtelnet_rs::Parser

pub struct Parser {
    pub options: CompatibilityTable,
    // some fields omitted
}

A telnet parser that handles the main parts of the protocol.

Fields

options: CompatibilityTable

Implementations

impl Parser

pub fn new() -> Self

Create a default, empty Parser with an internal buffer capacity of 128 bytes.

pub fn with_capacity(size: usize) -> Self

Create an empty parser, setting the initial internal buffer capcity.

pub fn with_support_and_capacity(size: usize, table: CompatibilityTable) -> Self

Create an parser, setting the initial internal buffer capacity and directly supplying a CompatibilityTable.

pub fn with_support(table: CompatibilityTable) -> Self

Create a parser, directly supplying a CompatibilityTable.

Uses the default initial buffer capacity of 128 bytes.

pub fn receive(&mut self, data: &[u8]) -> Vec<TelnetEvents>

Receive bytes into the internal buffer.

Arguments

• data - The bytes to be received. This should be sourced from the remote side of a connection.

Returns

Vec<events::TelnetEvents> - Any events parsed from the internal buffer with the new bytes.

pub fn linemode_enabled(&mut self) -> bool

Get whether the remote end supports and is using linemode.

pub fn escape_iac(data: Vec<u8>) -> Vec<u8>

Escape IAC bytes in data that is to be transmitted and treated as a non-IAC sequence.

Example

[255, 1, 6, 2] -> [255, 255, 1, 6, 2]

pub fn unescape_iac(data: Vec<u8>) -> Vec<u8>

Reverse escaped IAC bytes for non-IAC sequences and data.

Example

[255, 255, 1, 6, 2] -> [255, 1, 6, 2]

pub fn negotiate(&mut self, command: u8, option: u8) -> TelnetEvents

Negotiate an option.

Arguments

command - A u8 representing the telnet command code to be negotiated with. Example: WILL (251), WONT (252), DO (253), DONT (254)

option - A u8 representing the telnet option code that is being negotiated.

Returns

events::TelnetEvents::DataSend - A DataSend event to be processed.

Usage

This and other methods meant for sending data to the remote end will generate a TelnetEvents::Send(DataEvent) event.

These Send events contain a buffer that should be sent directly to the remote end, as it will have already been encoded properly.

pub fn _will(&mut self, option: u8) -> Option<TelnetEvents>

Indicate to the other side that you are able and wanting to utilize an option.

Arguments

option - A u8 representing the telnet option code that you want to enable locally.

Returns

Option<Vec<u8>> - The bytes to send to the remote side, or None if the option is not supported or already enabled.

Notes

This method will do nothing if the option is not "supported" locally via the CompatibilityTable.

pub fn _wont(&mut self, option: u8) -> Option<TelnetEvents>

Indicate to the other side that you are not wanting to utilize an option.

Arguments

option - A u8 representing the telnet option code that you want to disable locally.

Returns

Option<events::TelnetEvents::DataSend> - A DataSend event to be processed, or None if the option is already disabled.

pub fn _do(&mut self, option: u8) -> Option<TelnetEvents>

Indicate to the other side that you would like them to utilize an option.

Arguments

option - A u8 representing the telnet option code that you want to enable remotely.

Returns

Option<events::TelnetEvents::DataSend> - A DataSend event to be processed, or None if the option is not supported or already enabled.

Notes

This method will do nothing if the option is not "supported" remotely via the CompatibilityTable.

pub fn _dont(&mut self, option: u8) -> Option<TelnetEvents>

Indicate to the other side that you would like them to stop utilizing an option.

Arguments

option - A u8 representing the telnet option code that you want to disable remotely.

Returns

Option<events::TelnetEvents::DataSend> - A DataSend event to be processed, or None if the option is already disabled.

pub fn subnegotiation(
    &mut self,
    option: u8,
    data: Vec<u8>
) -> Option<TelnetEvents>

Send a subnegotiation for a locally supported option.

Arguments

option - A u8 representing the telnet option code for the negotiation.

data - A Vec<u8> containing the data to be sent in the subnegotiation. This data will have all IAC (255) byte values escaped.

Returns

Option<events::TelnetEvents::DataSend> - A DataSend event to be processed, or None if the option is not supported or is currently disabled.

Notes

This method will do nothing if the option is not "supported" locally via the CompatibilityTable.

pub fn subnegotiation_text(
    &mut self,
    option: u8,
    text: &str
) -> Option<TelnetEvents>

Send a subnegotiation for a locally supported option, using a string instead of raw byte values.

Arguments

option - A u8 representing the telnet option code for the negotiation.

text - A &str representing the text to be sent in the subnegotation. This data will have all IAC (255) byte values escaped.

Returns

Option<events::TelnetEvents::DataSend> - A DataSend event to be processed, or None if the option is not supported or is currently disabled.

Notes

This method will do nothing if the option is not "supported" locally via the CompatibilityTable.

pub fn send_text(&mut self, text: &str) -> TelnetEvents

Directly send a string, with appended \r\n, to the remote end, along with an IAC (255) GOAHEAD (249) sequence.

Returns

events::TelnetEvents::DataSend - A DataSend event to be processed.

Notes

The string will have IAC (255) bytes escaped before being sent.

Trait Implementations

impl Default for Parser

fn default() -> Parser

Returns the "default value" for a type.