Skip to content

docs: warn about retry-on-Partial streaming loops #217

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
seanmonstar merged 1 commit into from
Feb 5, 2026
Merged

docs: warn about retry-on-Partial streaming loops #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,10 +545,13 @@ impl<'h, 'b> Request<'h, 'b> {
}
}
}

/// Try to parse a buffer of bytes into the Request.
///
/// Returns byte offset in `buf` to start of HTTP body.
///
/// # Warning
/// In streaming code, if this returns `Status::Partial`, avoid retry loops
/// on a growing buffer without size/time limits; CPU usage may grow fast.
pub fn parse(&mut self, buf: &'b [u8]) -> Result<usize> {
self.parse_with_config(buf, &Default::default())
}
Expand Down Expand Up @@ -625,8 +628,11 @@ impl<'h, 'b> Response<'h, 'b> {
headers,
}
}

/// Try to parse a buffer of bytes into this `Response`.
///
/// # Warning
/// In streaming code, if this returns `Status::Partial`, avoid retry loops
/// on a growing buffer without size/time limits; CPU usage may grow fast.
pub fn parse(&mut self, buf: &'b [u8]) -> Result<usize> {
self.parse_with_config(buf, &ParserConfig::default())
}
Expand Down