blather: Change Log

⚠️ indicates a breaking change.

[Unreleased]

Proper value validation.
Params::get_fromstr() takes the place of get_param(), and is more explicit about what it does -- call the FromStr trait to parse the parameter's value.
Added the ability to the codec Decoder to send incoming Bytes through a channel. This can be activated using Codec::expect_bytes_channel().
Error::Param and ParamError are used to signal errors when getting/setting parameters from/to Params.
Params::add() was added as a no-conversion means to add Strings to a Params.
The bool parser in Params now also recognizes on and off.
Params::encode_anon_list()/Params::decode_anon_list() can be used to encode a Vec<T> in a Params buffer.
Params::encode_named_list()/Params_decode_named_list() serve the same role as their anon counter-parts, but the named variant supports using a namespace, allowing multiple lists in the same Params buffer.
Support for encoding/decoding binary data into Params values. Requires the feature bin.
Support for encoding/decoding types into/from Params values using the bincode crate. Requires the feature bincode.

⚠️ Major redesign
- Telegram no longer reimplement methods as thin wrappers around Params. Instead it implements Deref and DerefMut so the Params' functionality can be accessed through the Telegram.
Removed the types module; moved all its submodules to the top module.
Added missing error-handling in various places.
⚠️ Methods that previously could return Error::KeyNotFound now wrap their return value in Option instead.
⚠️ Renamed Params::have() to Params::contains().
⚠️ From<HashMap<String, String>> for Paramas changed to TryFrom, and now performs key/value validation.

⚠️ All the _def methods have been removed. Use iterator adapters instead.
⚠️ Removed the codec/utils module, including its expect_telegram() function.
⚠️ Error::BadState was removed. It was unused.
⚠️ Error::KeyNotFound was removed. Instead, methods use Option to signal that a key was not found.

⚠️ Error::IO carries with it std::io::Error rather than a string representation of the error.

Module codec::utils added for collecting Frame'd stream helpers.
codec::utils::expect_telegram() can be used to receive Telegrams with simple validation.
Add TryFrom<(&str, Params)> implementation for Telegram.

Dependency maintenance.
⚠️ Changed expect_chunks() to accept length as u64 rather than usize to support blobs on 32-bit platforms.
⚠️ Make skip() take in u64 rather than usize to be able to skip very large blobs.
⚠️ Use Bytes rather than BytesMut for chunk buffer.
⚠️ The decoder will wrap any errors relating to parsing incoming data in Error::Protocol() to signal that the incoming protocol fomrat was invalid.
⚠️ Make expect_chunks() fallible and check for zero-length.

⚠️ Removed three codec states:
- BytesMut has turned out not to be particularly useful.
- File was always a bad idea.
- Writer can have valid use-cases, but risk being misused as a substitute for File.

Use Bytes instead of BytesMut. Use Chunks instead of File or Writer, and let the application write the chunks as appropriate.