v0.2.0 (#11)

* Fix test command flags

* Remove unused file

* Add / expand documentation across the project

* Update license files to display on new GitHub repo pages

* Remove tests on README.md for brevity

* cargo fmt, cargo fix

* Update CHANGELOG.md

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 2024.03.20 - v0.2.0
+
+- Fixes several off-by-one errors in the decoding logic. (@xxx)
+- Added raw message support in the TelnetEvent enum. (@xxx)
+- Added tests for decoding logic. (@xxx)
+- General documentation improvements.
+
 ## 2023.02.18 - v0.1.0
 
 Initial release.

Cargo.toml

@@ -13,3 +13,6 @@ readme = "README.md"
 [dependencies]
 bytes = "1"
 tokio-util = { version = "0.7", features = ["codec"] }
+
+[lib]
+doctest = false

LICENSE-APACHE

@@ -0,0 +1,51 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

docs/LICENSE-MIT → LICENSE-MIT

@@ -1,4 +1,4 @@
-Copyright 2022 Rob Wagner <rob@sombia.com>
+Copyright 2023 Rob Wagner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -87,7 +87,7 @@ source code for an example of `nectar` in a more complex, real-world scenario.
 
 nectar source code is dual-licensed under either
 
-- **[MIT License](/docs/LICENSE-MIT)**
-- **[Apache License, Version 2.0](/docs/LICENSE-APACHE)**
+- **[MIT License](/LICENSE-MIT)**
+- **[Apache License, Version 2.0](/LICENSE-APACHE)**
 
 at your option.

examples/echo_server/src/main.rs

@@ -1,7 +1,8 @@
+use std::{error::Error, net::SocketAddr};
+
 use futures_lite::StreamExt;
 use futures_util::sink::SinkExt;
 use nectar::{event::TelnetEvent, TelnetCodec};
-use std::{error::Error, net::SocketAddr};
 use tokio::net::{TcpListener, TcpStream};
 use tokio_util::codec::Framed;
 

src/constants.rs

@@ -1,37 +1,59 @@
+// Echo a message back to the other side
 pub const ECHO: u8 = 1;
 
-pub const GA: u8 = 249; // Go Ahead
-pub const SGA: u8 = 3; // Suppress Go Ahead
-pub const IAC: u8 = 255; // Interpret As Command
-pub const SB: u8 = 250; // Subnegotiation Begin
-pub const NAWS: u8 = 31; // Negotiate About Window Size
-pub const SE: u8 = 240; // Subnegotiation End
+// Go Ahead
+pub const GA: u8 = 249;
 
-pub const EL: u8 = 248; // Erase Line
+// Suppress Go Ahead
+pub const SGA: u8 = 3;
 
-pub const NOP: u8 = 241; // No operation
-pub const NULL: u8 = 0; // No operation
+// Interpret As Command
+pub const IAC: u8 = 255;
 
-pub const CR: u8 = 13; // Carriage Return
-pub const LF: u8 = 10; // Line Feed
+// Subnegotiation Begin
+pub const SB: u8 = 250;
+
+// Negotiate About Window Size
+pub const NAWS: u8 = 31;
+
+// Subnegotiation End
+pub const SE: u8 = 240;
+
+// Erase Line
+pub const EL: u8 = 248;
+
+// No Operation
+pub const NOP: u8 = 241;
+
+// No Operation
+pub const NULL: u8 = 0;
+
+// Carriage Return
+pub const CR: u8 = 13;
+
+// Line Feed
+pub const LF: u8 = 10;
+
+// Carriage Return + Line Feed
 pub const CRLF: &[u8] = b"\r\n";
 
-// `<https://tools.ietf.org/search/rfc1116>` 2.1 The LINEMODE function
+// Linemode - <https://datatracker.ietf.org/doc/html/rfc1116#section-2.1>
 pub const LINEMODE: u8 = 34;
 
-// `<https://tools.ietf.org/search/rfc1116>` 2.2 LINEMODE suboption MODE
+// Linemode subnegotiation options -
+// <https://datatracker.ietf.org/doc/html/rfc1184#section-2>
 pub const MODE: u8 = 1; //
 
 // When set, the client side of the connection should process all input lines,
 // performing any editing function, and only send completed lines to the remote
-// side. When unset, client side should not process any input from the user, and
-// the server side should take care of all character processing that needs to be
-// done.
+// side. When unset, client side should not process any input from the user,
+// and the server side should take care of all character processing that needs
+// to be done.
 pub const LINEMODE_EDIT: u8 = 1;
 
 // When set, the client side should translate appropriate interrupts/signals to
-// their Telnet equivalent. (These would be IP, BRK, ABORT, EOF, and SUSP). When
-// unset, the client should pass interrupts/signals as their normal ASCII
+// their Telnet equivalent. (These would be IP, BRK, ABORT, EOF, and SUSP).
+// When unset, the client should pass interrupts/signals as their normal ASCII
 // values.
 pub const LINEMODE_TRAPSIG: u8 = 2;
 
@@ -52,30 +74,32 @@ pub const DO: u8 = 253;
 // option.
 pub const DONT: u8 = 254;
 
-/// EOR - End of Record - https://tintin.mudhalla.net/protocols/eor/
-pub const TELOPT_EOR: u8 = 25; // the telnet option for negotiation
-pub const EOR: u8 = 239; // the byte to send to indicate end of record
+// End of Record negotiation
+pub const TELOPT_EOR: u8 = 25;
 
-/// CHARSET - https://tools.ietf.org/html/rfc2066
-pub const CHARSET: u8 = 42;
+// End of Record - <https://tintin.mudhalla.net/protocols/eor/>
+pub const EOR: u8 = 239;
 
-/// Mud Server Status Protocol - https://mudhalla.net/tintin/protocols/mssp/
+// Mud Server Status Protocol - <https://mudhalla.net/tintin/protocols/mssp/>
 pub const MSSP: u8 = 70;
 
-/// Mud Client Compression Protocol (v2) -
-/// https://www.gammon.com.au/mccp/protocol.html
+// Mud Client Compression Protocol (v2) -
+// <https://www.gammon.com.au/mccp/protocol.html>
 pub const MCCP2: u8 = 86;
 
-/// Mud Sound Protocol - https://www.zuggsoft.com/zmud/msp.htm
+// Mud Sound Protocol - <https://www.zuggsoft.com/zmud/msp.htm>
 pub const MSP: u8 = 90;
 
-/// Mud eXtension Protocol - https://www.zuggsoft.com/zmud/mxp.htm
+// Mud eXtension Protocol - <https://www.zuggsoft.com/zmud/mxp.htm>
 pub const MXP: u8 = 91;
 
-/// Generic Mud Communication Protocol - https://www.gammon.com.au/gmcp
+// Generic Mud Communication Protocol - <https://www.gammon.com.au/gmcp>
 pub const GMCP: u8 = 201;
 
-/// CHARSET subnegotiation commands
+// CHARSET - <https://tools.ietf.org/html/rfc2066>
+pub const CHARSET: u8 = 42;
+
+// CHARSET subnegotiation commands
 pub const CHARSET_REQUEST: u8 = 1;
 pub const CHARSET_ACCEPTED: u8 = 2;
 pub const CHARSET_REJECTED: u8 = 3;

src/event.rs

@@ -4,23 +4,31 @@ use crate::{
     subnegotiation::SubnegotiationType,
 };
 
-/// Represents all Telnet events supported by Nectar.
-/// See `<https://tools.ietf.org/html/rfc854>` for more information.
+/// Represents message types supported by Nectar.
 #[derive(Debug, PartialEq, Eq)]
 pub enum TelnetEvent {
+    /// A single byte character.
     Character(u8),
     /// A message that guarantees it ends with `\r\n`.
     Message(String),
     /// A message that does not guarantee it ends with `\r\n`. Allows for
-    /// sending messages without enforced newlines. Used for outgoing
-    /// messages only.
+    /// sending messages without enforced newlines. Used for outgoing messages
+    /// only.
     RawMessage(String),
+    /// A message requesting the other side to perform an option.
     Do(TelnetOption),
+    /// A message indicating an intent to perform an option.
     Will(TelnetOption),
+    /// A message telling the other side to discontinue using an option, or that
+    /// it is no longer expected.
     Dont(TelnetOption),
+    /// A message refusing to perform an option.
     Wont(TelnetOption),
+    /// A message indicating that a subnegotiation is beginning.
     Subnegotiate(SubnegotiationType),
+    /// A message indicating that the data stream should resume.
     GoAhead,
+    /// No operation.
     Nop,
 }
 

src/lib.rs

@@ -1,18 +1,13 @@
 #![doc = include_str!("../README.md")]
 #![forbid(unsafe_code)]
 
-// RFC 854 `<https://tools.ietf.org/html/rfc854>`
-//
-// Originally based off of https://github.com/jtenner/telnet_codec, which has
-// been archived.
-
 /// Various byte or byte sequences used in the Telnet protocol.
 pub mod constants;
 /// Codec and Io errors that may occur while processing Telnet events.
 pub mod error;
 /// Top-level Telnet events, such as Message, Do, Will, and Subnegotiation.
 pub mod event;
-/// Telnet options such as Echo, GoAhead, and SuppressGoAhead.
+/// Telnet options such as `Echo`, `GoAhead`, and `SuppressGoAhead`.
 pub mod option;
 /// Telnet subnegotiation options.
 pub mod subnegotiation;
@@ -36,10 +31,12 @@ use crate::{
 type Result<T> = std::result::Result<T, TelnetError>;
 
 /// 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.
+/// extension protocols such as GMCP.
+///
+/// You should never have to interact with this directly.
 #[derive(Debug)]
 pub struct TelnetCodec {
+    /// Whether or not the client has enabled the Suppress Go Ahead option.
     pub sga: bool,
     max_buffer_length: usize,
     buffer: Vec<u8>,