pub struct HttpConfig { /* private fields */ }
Expand description
A configuration for Http
.
Implementations
sourceimpl HttpConfig
impl HttpConfig
sourcepub fn new() -> HttpConfig
pub fn new() -> HttpConfig
Creates a default Http
config.
sourcepub fn build(&mut self) -> HttpConfig
pub fn build(&mut self) -> HttpConfig
Builds the config, creating an owned version of it.
sourcepub fn http1_only(&mut self, val: bool) -> &mut HttpConfig
pub fn http1_only(&mut self, val: bool) -> &mut HttpConfig
Sets whether HTTP1 is required.
Default is false
.
sourcepub fn http1_half_close(&mut self, val: bool) -> &mut HttpConfig
pub fn http1_half_close(&mut self, val: bool) -> &mut HttpConfig
Set whether HTTP/1 connections should support half-closures.
Clients can chose to shutdown their write-side while waiting
for the server to respond. Setting this to true
will
prevent closing the connection immediately if read
detects an EOF in the middle of a request.
Default is false
.
sourcepub fn http1_keep_alive(&mut self, val: bool) -> &mut HttpConfig
pub fn http1_keep_alive(&mut self, val: bool) -> &mut HttpConfig
Enables or disables HTTP/1 keep-alive.
Default is true.
sourcepub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut HttpConfig
pub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut HttpConfig
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.
sourcepub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut HttpConfig
pub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut HttpConfig
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.
sourcepub fn http1_writev(&mut self, val: bool) -> &mut HttpConfig
pub fn http1_writev(&mut self, val: bool) -> &mut HttpConfig
Set whether HTTP/1 connections should try to use vectored writes, or always flatten into a single buffer.
Note that setting this to false may mean more copies of body data, but may also improve performance when an IO transport doesn’t support vectored writes well, such as most TLS implementations.
Setting this to true will force hyper to use queued strategy which may eliminate unnecessary cloning on some TLS backends
Default is auto
. In this mode hyper will try to guess which
mode to use
sourcepub fn http2_only(&mut self, val: bool) -> &mut HttpConfig
pub fn http2_only(&mut self, val: bool) -> &mut HttpConfig
Sets whether HTTP2 is required.
Default is false
sourcepub fn http2_initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut HttpConfig
pub fn http2_initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut HttpConfig
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.
sourcepub fn http2_initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut HttpConfig
pub fn http2_initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut HttpConfig
Sets the max connection-level flow control for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
sourcepub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut HttpConfig
pub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut HttpConfig
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
.
sourcepub fn http2_max_frame_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut HttpConfig
pub fn http2_max_frame_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut HttpConfig
Sets the maximum frame size to use for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
sourcepub fn http2_max_concurrent_streams(
&mut self,
max: impl Into<Option<u32>>
) -> &mut HttpConfig
pub fn http2_max_concurrent_streams(
&mut self,
max: impl Into<Option<u32>>
) -> &mut HttpConfig
Sets the SETTINGS_MAX_CONCURRENT_STREAMS
option for HTTP2
connections.
Default is no limit (std::u32::MAX
). Passing None
will do nothing.
sourcepub fn http2_keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut HttpConfig
pub fn http2_keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut HttpConfig
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.
sourcepub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut HttpConfig
pub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut HttpConfig
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.
sourcepub fn max_buf_size(&mut self, max: usize) -> &mut HttpConfig
pub fn max_buf_size(&mut self, max: usize) -> &mut HttpConfig
Set the maximum buffer size for the connection.
Default is ~400kb.
Panics
The minimum value allowed is 8192. This method panics if the passed max
is less than the minimum.
sourcepub fn pipeline_flush(&mut self, enabled: bool) -> &mut HttpConfig
pub fn pipeline_flush(&mut self, enabled: bool) -> &mut HttpConfig
Aggregates flushes to better support pipelined responses.
Experimental, may have bugs.
Default is false.
Trait Implementations
sourceimpl Clone for HttpConfig
impl Clone for HttpConfig
sourcefn clone(&self) -> HttpConfig
fn clone(&self) -> HttpConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HttpConfig
impl Debug for HttpConfig
sourceimpl Default for HttpConfig
impl Default for HttpConfig
sourcefn default() -> HttpConfig
fn default() -> HttpConfig
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl !RefUnwindSafe for HttpConfig
impl Send for HttpConfig
impl Sync for HttpConfig
impl Unpin for HttpConfig
impl !UnwindSafe for HttpConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more