Skip to content

fix(server): Enforce serve_connection result usage #178

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 3 commits into from
Apr 2, 2025
Merged

fix(server): Enforce serve_connection result usage #178

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98eba06
fix(server): Enforce `serve_connection` result usage
Sol-Ell Apr 2, 2025
790dc69
refactor(server): Enforce `must_use` at the type level
Sol-Ell Apr 2, 2025
422c407
docs(server): Improve clarity of `UpgradableConnection` documentation
Sol-Ell Apr 2, 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
14 changes: 12 additions & 2 deletions src/server/conn/auto/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,12 @@ where
}

pin_project! {
/// Connection future.
/// A [`Future`](core::future::Future) representing an HTTP/1 connection, returned from
/// [`Builder::serve_connection`](struct.Builder.html#method.serve_connection).
///
/// To drive HTTP on this connection this future **must be polled**, typically with
/// `.await`. If it isn't polled, no progress will be made on this connection.
#[must_use = "futures do nothing unless polled"]
pub struct Connection<'a, I, S, E>
where
S: HttpService<Incoming>,
Expand Down Expand Up @@ -490,7 +495,12 @@ where
}

pin_project! {
/// Connection future.
/// An upgradable [`Connection`], returned by
/// [`Builder::serve_upgradable_connection`](struct.Builder.html#method.serve_connection_with_upgrades).
///
/// To drive HTTP on this connection this future **must be polled**, typically with
/// `.await`. If it isn't polled, no progress will be made on this connection.
#[must_use = "futures do nothing unless polled"]
pub struct UpgradeableConnection<'a, I, S, E>
where
S: HttpService<Incoming>,
Expand Down