Skip to content

Commit

Permalink
Add changelog entry for 0.29.1 documenting ByteWriter and ByteReader
Browse files Browse the repository at this point in the history
  • Loading branch information
joshtriplett authored and sdroege committed Feb 18, 2025
1 parent 4a2cb34 commit 6aa5fe4
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
15 changes: 14 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.29.1] - 2025-02-18
### Added
- Added wrappers that allow treating a WebSocket as a byte stream. `ByteWriter`
allows using any `Sink<Stream>` as an `AsyncWrite`. `ByteReader` allows using
any `Stream<Item = tungstenite::Result<Message>>` as an `AsyncRead`.

Note that `ByteReader` will treat all bytes received as uniform, including
for instance the contents of Close or Ping/Pong messages; if you need to
handle the contents of a `Close`, don't use this.

You may want to wrap these in a `BufWriter` or `BufReader` for efficiency.

## [0.29.0] - 2025-02-17
### Changed
- Update to tungstenite 0.26.
Expand Down Expand Up @@ -224,7 +236,8 @@ No changelog is available for older versions as of yet.
-->


[Unreleased]: https://github.com/sdroege/async-tungstenite/compare/0.29.0...HEAD
[Unreleased]: https://github.com/sdroege/async-tungstenite/compare/0.29.1...HEAD
[0.29.1]: https://github.com/sdroege/async-tungstenite/compare/0.29.1...0.29.0
[0.29.0]: https://github.com/sdroege/async-tungstenite/compare/0.29.0...0.28.2
[0.28.2]: https://github.com/sdroege/async-tungstenite/compare/0.28.2...0.28.1
[0.28.1]: https://github.com/sdroege/async-tungstenite/compare/0.28.1...0.28.0
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock.msrv

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license = "MIT"
homepage = "https://github.com/sdroege/async-tungstenite"
repository = "https://github.com/sdroege/async-tungstenite"
documentation = "https://docs.rs/async-tungstenite"
version = "0.29.0"
version = "0.29.1"
edition = "2018"
readme = "README.md"
include = ["examples/**/*", "src/**/*", "LICENSE", "README.md", "CHANGELOG.md"]
Expand Down

0 comments on commit 6aa5fe4

Please sign in to comment.