Skip to content

Commit 6aa5fe4

Browse files
joshtriplettsdroege
authored andcommitted
Add changelog entry for 0.29.1 documenting ByteWriter and ByteReader
1 parent 4a2cb34 commit 6aa5fe4

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [0.29.1] - 2025-02-18
8+
### Added
9+
- Added wrappers that allow treating a WebSocket as a byte stream. `ByteWriter`
10+
allows using any `Sink<Stream>` as an `AsyncWrite`. `ByteReader` allows using
11+
any `Stream<Item = tungstenite::Result<Message>>` as an `AsyncRead`.
12+
13+
Note that `ByteReader` will treat all bytes received as uniform, including
14+
for instance the contents of Close or Ping/Pong messages; if you need to
15+
handle the contents of a `Close`, don't use this.
16+
17+
You may want to wrap these in a `BufWriter` or `BufReader` for efficiency.
18+
719
## [0.29.0] - 2025-02-17
820
### Changed
921
- Update to tungstenite 0.26.
@@ -224,7 +236,8 @@ No changelog is available for older versions as of yet.
224236
-->
225237

226238

227-
[Unreleased]: https://github.com/sdroege/async-tungstenite/compare/0.29.0...HEAD
239+
[Unreleased]: https://github.com/sdroege/async-tungstenite/compare/0.29.1...HEAD
240+
[0.29.1]: https://github.com/sdroege/async-tungstenite/compare/0.29.1...0.29.0
228241
[0.29.0]: https://github.com/sdroege/async-tungstenite/compare/0.29.0...0.28.2
229242
[0.28.2]: https://github.com/sdroege/async-tungstenite/compare/0.28.2...0.28.1
230243
[0.28.1]: https://github.com/sdroege/async-tungstenite/compare/0.28.1...0.28.0

Cargo.lock.msrv

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ license = "MIT"
88
homepage = "https://github.com/sdroege/async-tungstenite"
99
repository = "https://github.com/sdroege/async-tungstenite"
1010
documentation = "https://docs.rs/async-tungstenite"
11-
version = "0.29.0"
11+
version = "0.29.1"
1212
edition = "2018"
1313
readme = "README.md"
1414
include = ["examples/**/*", "src/**/*", "LICENSE", "README.md", "CHANGELOG.md"]

0 commit comments

Comments
 (0)