Skip to content

docs(body): add streaming read examples - #4148

Merged
seanmonstar merged 2 commits into
hyperium:masterfrom
fzlzjerry:issue-2201
Aug 10, 2026
Merged

docs(body): add streaming read examples#4148
seanmonstar merged 2 commits into
hyperium:masterfrom
fzlzjerry:issue-2201

Conversation

@fzlzjerry

Copy link
Copy Markdown
Contributor

Summary

  • document how to read data and trailer frames from an incoming body
  • explain how frame-by-frame processing preserves connection back-pressure
  • show intentional whole-body collection and warn about unbounded buffering

Testing

  • cargo fmt --check
  • cargo test --doc --features full
  • cargo test --features full
  • cargo clippy --features full -- -D warnings
  • RUSTDOCFLAGS='-D rustdoc::broken-intra-doc-links' cargo doc --no-deps --features full

Closes #2201

Show how to process data and trailer frames while preserving back-pressure, and contrast that with intentionally collecting a bounded body in memory.

Closes hyperium#2201
Comment thread src/body/mod.rs
@seanmonstar
seanmonstar marked this pull request as ready for review August 10, 2026 16:04
@seanmonstar
seanmonstar merged commit af432e9 into hyperium:master Aug 10, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand 'body' documentation to explain body streams

2 participants