Skip to content

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

Draft
fzlzjerry wants to merge 1 commit into
hyperium:masterfrom
fzlzjerry:issue-2201
Draft

docs(body): add streaming read examples#4148
fzlzjerry wants to merge 1 commit into
hyperium:masterfrom
fzlzjerry:issue-2201

Conversation

@fzlzjerry

Copy link
Copy Markdown

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
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

1 participant