docs(http1): clarify HTTP1 preserve case option

This commit is contained in:
Sean McArthur
2021-11-16 11:29:33 -08:00
parent a12db28542
commit a1502e1067
4 changed files with 36 additions and 8 deletions

View File

@@ -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.
///

View File

@@ -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.
///

View File

@@ -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.
///

View File

@@ -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.
///