Skip to content

io: document the default capacity of the ReaderStream #7147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ADD-SP merged 4 commits into from
Dec 12, 2025
Merged

io: document the default capacity of the ReaderStream #7147

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f0c5fb
io: document default `ReaderStream` capacity
Owez Feb 8, 2025
b443ea0
merge: sync changes from the base branch
ADD-SP Dec 12, 2025
304b803
fix spellcheck
ADD-SP Dec 12, 2025
f8f92d3
clarify the default capacity is not the part of the semver
ADD-SP Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tokio-util/src/io/reader_stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ impl<R: AsyncRead> ReaderStream<R> {
/// Convert an [`AsyncRead`] into a [`Stream`] with item type
/// `Result<Bytes, std::io::Error>`.
///
/// Currently, the default capacity 4096 bytes (4 KiB).
/// This capacity is not part of the semver contract
/// and may be tweaked in future releases without
/// requiring a major version bump.
///
/// [`AsyncRead`]: tokio::io::AsyncRead
/// [`Stream`]: futures_core::Stream
pub fn new(reader: R) -> Self {
Expand Down