Skip to content

Commit caec8ef

Browse files
committed
prepare release
1 parent 153c1a1 commit caec8ef

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
44

55
This project adheres to [Semantic Versioning](https://semver.org).
66

7+
## [1.1.1] - 2025-10-01
8+
9+
### Added
10+
11+
`bytes::Buf` implementations for `Cursor<BufList>` and `Cursor<&BufList>`, to go with the existing `bytes::Buf` implementation for `BufList` itself. This way, the same `BufList` can have multiple cursors over it that all use the `bytes::Buf` implementation.
12+
713
## [1.1.0] - 2025-09-29
814

915
### Changed
@@ -68,6 +74,7 @@ This project adheres to [Semantic Versioning](https://semver.org).
6874

6975
- Initial release.
7076

77+
[1.1.1]: https://github.com/sunshowers-code/buf-list/releases/tag/1.1.1
7178
[1.1.0]: https://github.com/sunshowers-code/buf-list/releases/tag/1.1.0
7279
[1.0.3]: https://github.com/sunshowers-code/buf-list/releases/tag/1.0.3
7380
[1.0.2]: https://github.com/sunshowers-code/buf-list/releases/tag/1.0.2

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ If you've ever wanted a `Vec<Bytes>` or a `VecDeque<Bytes>`, this type is for yo
1717

1818
## Cursors
1919

20-
This crate also provides `Cursor`, which is a cursor type around a `BufList`. A `Cursor`
21-
around a `BufList` implements [`Seek`](std::io::Seek), [`Read`](std::io::Read) and
22-
[`BufRead`](std::io::BufRead), similar to `std::io::Cursor`.
20+
This crate also provides `Cursor`, which is a cursor type around a
21+
`BufList`. Similar to similar to `std::io::Cursor`, a `Cursor` around
22+
a `BufList` implements
23+
24+
* [`Seek`](std::io::Seek), [`Read`](std::io::Read), and [`BufRead`](std::io::BufRead)
25+
* `bytes::Buf` as well (in other words, both `BufList`s and `Cursor`s over them
26+
can be passed into any APIs that accept `Buf`).
2327

2428
## Examples
2529

src/lib.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@
2121
//!
2222
//! # Cursors
2323
//!
24-
//! This crate also provides [`Cursor`], which is a cursor type around a [`BufList`]. A [`Cursor`]
25-
//! around a [`BufList`] implements [`Seek`](std::io::Seek), [`Read`](std::io::Read) and
26-
//! [`BufRead`](std::io::BufRead), similar to [`std::io::Cursor`].
24+
//! This crate also provides [`Cursor`], which is a cursor type around a
25+
//! [`BufList`]. Similar to similar to [`std::io::Cursor`], a [`Cursor`] around
26+
//! a [`BufList`] implements
27+
//!
28+
//! * [`Seek`](std::io::Seek), [`Read`](std::io::Read), and [`BufRead`](std::io::BufRead)
29+
//! * [`bytes::Buf`] as well (in other words, both [`BufList`]s and [`Cursor`]s over them
30+
//! can be passed into any APIs that accept `Buf`).
2731
//!
2832
//! # Examples
2933
//!

0 commit comments

Comments
 (0)