Skip to content

Commit

Permalink
docs(http1): clarify HTTP1 preserve case option
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmonstar committed Nov 16, 2021
1 parent a12db28 commit a1502e1
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 8 deletions.
11 changes: 9 additions & 2 deletions src/client/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1050,8 +1050,15 @@ impl Builder {
self
}

/// Set whether HTTP/1 connections will write header names as provided
/// at the socket level.
/// Set whether to support preserving original header cases.
///
/// Currently, this will record the original cases received, and store them
/// in a private extension on the `Response`. It will also look for and use
/// such an extension in any provided `Request`.
///
/// Since the relevant extension is still private, there is no way to
/// interact with the original cases. The only effect this can have now is
/// to forward the cases in a proxy-like fashion.
///
/// Note that this setting does not affect HTTP/2.
///
Expand Down
11 changes: 9 additions & 2 deletions src/client/conn.rs
Original file line number Diff line number Diff line change
Expand Up @@ -626,8 +626,15 @@ impl Builder {
self
}

/// Set whether HTTP/1 connections will write header names as provided
/// at the socket level.
/// Set whether to support preserving original header cases.
///
/// Currently, this will record the original cases received, and store them
/// in a private extension on the `Response`. It will also look for and use
/// such an extension in any provided `Request`.
///
/// Since the relevant extension is still private, there is no way to
/// interact with the original cases. The only effect this can have now is
/// to forward the cases in a proxy-like fashion.
///
/// Note that this setting does not affect HTTP/2.
///
Expand Down
11 changes: 9 additions & 2 deletions src/server/conn.rs
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,15 @@ impl<E> Http<E> {
self
}

/// Set whether HTTP/1 connections will write header names as provided
/// at the socket level.
/// Set whether to support preserving original header cases.
///
/// Currently, this will record the original cases received, and store them
/// in a private extension on the `Request`. It will also look for and use
/// such an extension in any provided `Response`.
///
/// Since the relevant extension is still private, there is no way to
/// interact with the original cases. The only effect this can have now is
/// to forward the cases in a proxy-like fashion.
///
/// Note that this setting does not affect HTTP/2.
///
Expand Down
11 changes: 9 additions & 2 deletions src/server/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,15 @@ impl<I, E> Builder<I, E> {
self
}

/// Set whether HTTP/1 connections will write header names as provided
/// at the socket level.
/// Set whether to support preserving original header cases.
///
/// Currently, this will record the original cases received, and store them
/// in a private extension on the `Request`. It will also look for and use
/// such an extension in any provided `Response`.
///
/// Since the relevant extension is still private, there is no way to
/// interact with the original cases. The only effect this can have now is
/// to forward the cases in a proxy-like fashion.
///
/// Note that this setting does not affect HTTP/2.
///
Expand Down

0 comments on commit a1502e1

Please sign in to comment.