A low-level Telnet protocol implementation for MUD clients, written in Rust.
libmudtelnet is a fork of libtelnet-rs, which is itself inspired by the libtelnet.
See CHANGELOG.md.
Check src/tests.rs for an example parser. For a larger
example, see the Blightmud MUD client that uses libmudtelnet for its Telnet
handling.
First, construct a parser with Parser::new(). Ideally, you would
place this parser somewhere directly behind a socket or external source of data.
When data comes in from the socket, immediately send it into the parser with
parser.receive(data). This will append it to the current internal
buffer, and process and return any telnet events to be looped over and handled
as your application requires.
Any text to be sent back over the socket to the remote end should be sent
through parser.send_text(data) to ensure data will be encoded
properly for the telnet protocol. Data to be sent will be provided either by
a events::TelnetEvents::DataSend event after processing, or as a return from
any method used for sending data.
The initial release of libmudtelnet has been tested for compatibility with
libtelnet-rs. In general while much of the code has been rewritten to be more
idiomatic Rust, the API is the same and breaking changes have been avoided. An
upcoming semver incompatible release will be made with broader API changes in
the near future.
See CHANGELOG.md for more details.
Many thanks to:
- envis10n for his work on libtelnet-rs, which
libmudtelnetis forked from. - Sean Middleditch for his work on libtelnet, which inspired
libtelnet-rs.