Struct salvo::hyper::client::conn::Builder [−]
pub struct Builder { /* fields omitted */ }
Expand description
A builder to configure an HTTP connection.
After setting options, the builder is used to create a handshake future.
Implementations
impl Builder
impl Builder
Provide an executor to execute background HTTP2 tasks.
pub fn http09_responses(&mut self, enabled: bool) -> &mut Builder
pub fn http09_responses(&mut self, enabled: bool) -> &mut Builder
Set whether HTTP/0.9 responses should be tolerated.
Default is false.
pub fn http1_allow_spaces_after_header_name_in_responses(
&mut self,
enabled: bool
) -> &mut Builder
pub fn http1_allow_spaces_after_header_name_in_responses(
&mut self,
enabled: bool
) -> &mut Builder
Set whether HTTP/1 connections will accept spaces between header names and the colon that follow them in responses.
You probably don’t need this, here is what RFC 7230 Section 3.2.4. has to say about it:
No whitespace is allowed between the header field-name and colon. In the past, differences in the handling of such whitespace have led to security vulnerabilities in request routing and response handling. A server MUST reject any received request message that contains whitespace between a header field-name and colon with a response code of 400 (Bad Request). A proxy MUST remove any such whitespace from a response message before forwarding the message downstream.
Note that this setting does not affect HTTP/2.
Default is false.
pub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut Builder
pub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut Builder
Set whether HTTP/1 connections will write header names as title case at the socket level.
Note that this setting does not affect HTTP/2.
Default is false.
pub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut Builder
pub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut Builder
Set whether HTTP/1 connections will write header names as provided at the socket level.
Note that this setting does not affect HTTP/2.
Default is false.
pub fn http1_read_buf_exact_size(&mut self, sz: Option<usize>) -> &mut Builder
pub fn http1_read_buf_exact_size(&mut self, sz: Option<usize>) -> &mut Builder
Sets the exact size of the read buffer to always use.
Note that setting this option unsets the http1_max_buf_size
option.
Default is an adaptive read buffer.
pub fn http1_max_buf_size(&mut self, max: usize) -> &mut Builder
pub fn http1_max_buf_size(&mut self, max: usize) -> &mut Builder
Set the maximum buffer size for the connection.
Default is ~400kb.
Note that setting this option unsets the http1_read_exact_buf_size
option.
Panics
The minimum value allowed is 8192. This method panics if the passed max
is less than the minimum.
pub fn http2_only(&mut self, enabled: bool) -> &mut Builder
pub fn http2_only(&mut self, enabled: bool) -> &mut Builder
Sets whether HTTP2 is required.
Default is false.
pub fn http2_initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Builder
pub fn http2_initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Builder
Sets the SETTINGS_INITIAL_WINDOW_SIZE
option for HTTP2
stream-level flow control.
Passing None
will do nothing.
If not set, hyper will use a default.
pub fn http2_initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Builder
pub fn http2_initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Builder
Sets the max connection-level flow control for HTTP2
Passing None
will do nothing.
If not set, hyper will use a default.
pub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut Builder
pub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut Builder
Sets whether to use an adaptive flow control.
Enabling this will override the limits set in
http2_initial_stream_window_size
and
http2_initial_connection_window_size
.
pub fn http2_max_frame_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Builder
pub fn http2_max_frame_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Builder
Sets the maximum frame size to use for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
pub fn http2_keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut Builder
pub fn http2_keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut Builder
Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.
Pass None
to disable HTTP2 keep-alive.
Default is currently disabled.
Cargo Feature
Requires the runtime
cargo feature to be enabled.
pub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut Builder
pub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut Builder
Sets a timeout for receiving an acknowledgement of the keep-alive ping.
If the ping is not acknowledged within the timeout, the connection will
be closed. Does nothing if http2_keep_alive_interval
is disabled.
Default is 20 seconds.
Cargo Feature
Requires the runtime
cargo feature to be enabled.
pub fn http2_keep_alive_while_idle(&mut self, enabled: bool) -> &mut Builder
pub fn http2_keep_alive_while_idle(&mut self, enabled: bool) -> &mut Builder
Sets whether HTTP2 keep-alive should apply while the connection is idle.
If disabled, keep-alive pings are only sent while there are open
request/responses streams. If enabled, pings are also sent when no
streams are active. Does nothing if http2_keep_alive_interval
is
disabled.
Default is false
.
Cargo Feature
Requires the runtime
cargo feature to be enabled.
pub fn http2_max_concurrent_reset_streams(&mut self, max: usize) -> &mut Builder
pub fn http2_max_concurrent_reset_streams(&mut self, max: usize) -> &mut Builder
Sets the maximum number of HTTP2 concurrent locally reset streams.
See the documentation of h2::client::Builder::max_concurrent_reset_streams
for more
details.
The default value is determined by the h2
crate.
Constructs a connection with the configured options and IO.
See client::conn
for more.
Note, if Connection
is not await
-ed, SendRequest
will
do nothing.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Builder
impl !UnwindSafe for Builder
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more