Skip to content

Sync documentation for hyper_util::server::conn::auto::Http1Builder::header_read_timeout with hyper's hyper::server::conn::http1::Builder::header_read_timeout. #137

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
merged 2 commits into from
Jul 22, 2024
Merged

Sync documentation for hyper_util::server::conn::auto::Http1Builder::header_read_timeout with hyper's hyper::server::conn::http1::Builder::header_read_timeout. #137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
235465d
Sync documentation for Http1Builder::header_read_timeout with hyper's…
aaronriekenberg Jul 12, 2024
af8821a
Review comments.
aaronriekenberg Jul 20, 2024
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
9 changes: 7 additions & 2 deletions src/server/conn/auto.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,8 +690,13 @@ impl<E> Http1Builder<'_, E> {
/// Set a timeout for reading client request headers. If a client does not
/// transmit the entire header within this time, the connection is closed.
///
/// Default is None.
pub fn header_read_timeout(&mut self, read_timeout: Duration) -> &mut Self {
/// Requires a [`Timer`] set by [`Http1Builder::timer`] to take effect. Panics if `header_read_timeout` is configured
/// without a [`Timer`].
///
/// Pass `None` to disable.
///
/// Default is currently 30 seconds, but do not depend on that.
pub fn header_read_timeout(&mut self, read_timeout: impl Into<Option<Duration>>) -> &mut Self {
self.inner.http1.header_read_timeout(read_timeout);
self
}
Expand Down