⚠️ indicates a breaking change.

[Unreleased]

Details

Added

Changed

Removed

---

[0.11.0] - 2024-09-22

Details

Changed

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

Removed

• ⚠️ Error no longer implements PartialEq.
• ⚠️ Telegram::clear() was removed because there's no "default" topic.
• Remove From<Params> for Telegram (since it needs a topic now).

---

[0.10.1] - 2024-08-06

Details

Added

• 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.

---

[0.10.0] - 2024-02-23

Details

Changed

• 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

• ⚠️ 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.