Skip to content

Commit

Permalink
docs(client): better describe Uri forms are sent as-is
Browse files Browse the repository at this point in the history
Closes #3693
  • Loading branch information
GlenDC authored and seanmonstar committed Jun 28, 2024
1 parent aa7ff60 commit 111d038
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions src/client/conn/http1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,16 @@ where
///
/// `req` must have a `Host` header.
///
/// Absolute-form `Uri`s are not required. If received, they will be serialized
/// as-is.
/// # Uri
///
/// The `Uri` of the request is serialized as-is.
///
/// - Usually you want origin-form (`/path?query`).
/// - For sending to an HTTP proxy, you want to send in absolute-form
/// (`https://hyper.rs/guides`).
///
/// This is however not enforced or validated and it is up to the user
/// of this method to ensure the `Uri` is correct for their intended purpose.
pub fn send_request(
&mut self,
req: Request<B>,
Expand Down

0 comments on commit 111d038

Please sign in to comment.