Skip to content

Commit

Permalink
docs: update CHANGELOG for IAC unescape bug
Browse files Browse the repository at this point in the history
  • Loading branch information
cpu committed Nov 11, 2023
1 parent 209a292 commit d711847
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,21 @@ Initial release of `libmudtelnet` - a fork of `libtelnet-rs`.
byte during Telnet subnegotiation processing.
* Fixed a panic when Telnet option code 0xFF is negotiated, and a truncated
subnegotiation (e.g. `IAC SB IAC SE`) is received.
* Multiple escaped `IAC` bytes (`e.g. IAC IAC IAC IAC`) are now properly
unescaped (e.g. `IAC IAC`) instead of truncated (e.g. `IAC`).

## Features

* Many API types now derive helpful traits (`Debug`, `Eq`, etc.).
* An optional `arbitrary` crate feature is now available to enable generating
arbitrary `event::TelnetIAC`, `event::TelnetNegotiation` and `event::TelnetSubnegotiation`
instances for testing.

## Misc

* CI improvements.
* Fuzz testing.
* Simple benchmarking.
* Small performance and safety improvements (avoiding direct indexing, etc.).

# v2.0.0
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ 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].

A [libtelnet]-inspired telnet parser for Rust.

[libtelnet-rs]: https://github.com/envis10n/libtelnet-rs
[libtelnet]: https://github.com/seanmiddleditch/libtelnet

Expand Down Expand Up @@ -45,10 +43,13 @@ any method used for sending data.

# Compatibility

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 break
changes have been avoided. An upcoming semver incompatible release will be made with broader API changes
in the near future.
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](CHANGELOG.md) for more details.

# Credits

Expand Down

0 comments on commit d711847

Please sign in to comment.