Struct Builder
struct Builder<Ex> { ... }
A builder to configure an HTTP connection.
After setting options, the builder is used to create a handshake future.
Note: The default values of options are not considered stable. They are subject to change at any time.
Implementations
impl<Ex> Builder<Ex>
fn new(exec: Ex) -> Builder<Ex>Creates a new connection builder.
fn timer<M>(self: &mut Self, timer: M) -> &mut Builder<Ex> where M: Timer + Send + Sync + 'staticProvide a timer to execute background HTTP2 tasks.
fn initial_stream_window_size<impl Into<Option<u32>>: Into<Option<u32>>>(self: &mut Self, sz: impl Into<Option<u32>>) -> &mut SelfSets the
SETTINGS_INITIAL_WINDOW_SIZEoption for HTTP2 stream-level flow control.Passing
Nonewill do nothing.If not set, hyper will use a default.
fn initial_connection_window_size<impl Into<Option<u32>>: Into<Option<u32>>>(self: &mut Self, sz: impl Into<Option<u32>>) -> &mut SelfSets the max connection-level flow control for HTTP2
Passing
Nonewill do nothing.If not set, hyper will use a default.
fn initial_max_send_streams<impl Into<Option<usize>>: Into<Option<usize>>>(self: &mut Self, initial: impl Into<Option<usize>>) -> &mut SelfSets the initial maximum of locally initiated (send) streams.
This value will be overwritten by the value included in the initial SETTINGS frame received from the peer as part of a connection preface.
Passing
Nonewill do nothing.If not set, hyper will use a default.
fn adaptive_window(self: &mut Self, enabled: bool) -> &mut SelfSets whether to use an adaptive flow control.
Enabling this will override the limits set in
initial_stream_window_sizeandinitial_connection_window_size.fn max_frame_size<impl Into<Option<u32>>: Into<Option<u32>>>(self: &mut Self, sz: impl Into<Option<u32>>) -> &mut SelfSets the maximum frame size to use for HTTP2.
Default is currently 16KB, but can change.
fn max_header_list_size(self: &mut Self, max: u32) -> &mut SelfSets the max size of received header frames.
Default is currently 16KB, but can change.
fn header_table_size<impl Into<Option<u32>>: Into<Option<u32>>>(self: &mut Self, size: impl Into<Option<u32>>) -> &mut SelfSets the header table size.
This setting informs the peer of the maximum size of the header compression table used to encode header blocks, in octets. The encoder may select any value equal to or less than the header table size specified by the sender.
The default value of crate
h2is 4,096.fn max_concurrent_streams<impl Into<Option<u32>>: Into<Option<u32>>>(self: &mut Self, max: impl Into<Option<u32>>) -> &mut SelfSets the maximum number of concurrent streams.
The maximum concurrent streams setting only controls the maximum number of streams that can be initiated by the remote peer. In other words, when this setting is set to 100, this does not limit the number of concurrent streams that can be created by the caller.
It is recommended that this value be no smaller than 100, so as to not unnecessarily limit parallelism. However, any value is legal, including 0. If
maxis set to 0, then the remote will not be permitted to initiate streams.Note that streams in the reserved state, i.e., push promises that have been reserved but the stream has not started, do not count against this setting.
Also note that if the remote does exceed the value set here, it is not a protocol level error. Instead, the
h2library will immediately reset the stream.See Section 5.1.2 in the HTTP/2 spec for more details.
fn keep_alive_interval<impl Into<Option<Duration>>: Into<Option<Duration>>>(self: &mut Self, interval: impl Into<Option<Duration>>) -> &mut SelfSets an interval for HTTP2 Ping frames should be sent to keep a connection alive.
Pass
Noneto disable HTTP2 keep-alive.Default is currently disabled.
fn keep_alive_timeout(self: &mut Self, timeout: Duration) -> &mut SelfSets 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
keep_alive_intervalis disabled.Default is 20 seconds.
fn keep_alive_while_idle(self: &mut Self, enabled: bool) -> &mut SelfSets 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
keep_alive_intervalis disabled.Default is
false.fn max_concurrent_reset_streams(self: &mut Self, max: usize) -> &mut SelfSets the maximum number of HTTP2 concurrent locally reset streams.
See the documentation of
h2::client::Builder::max_concurrent_reset_streamsfor more details.The default value is determined by the
h2crate.fn max_send_buf_size(self: &mut Self, max: usize) -> &mut SelfSet the maximum write buffer size for each HTTP/2 stream.
Default is currently 1MB, but may change.
Panics
The value must be no larger than
u32::MAX.fn max_pending_accept_reset_streams<impl Into<Option<usize>>: Into<Option<usize>>>(self: &mut Self, max: impl Into<Option<usize>>) -> &mut SelfConfigures the maximum number of pending reset streams allowed before a GOAWAY will be sent.
This will default to the default value set by the
h2crate. As of v0.4.0, it is 20.See https://github.com/hyperium/hyper/issues/2877 for more information.
fn handshake<T, B>(self: &Self, io: T) -> impl Future<Output = crate::Result<(SendRequest<B>, Connection<T, B, Ex>)>> where T: Read + Write + Unpin, B: Body + 'static, <B as >::Data: Send, <B as >::Error: Into<Box<dyn Error + Send + Sync>>, Ex: Http2ClientConnExec<B, T> + UnpinConstructs a connection with the configured options and IO. See
client::connfor more.Note, if
Connectionis notawait-ed,SendRequestwill do nothing.
impl<Ex> Freeze for Builder<Ex>
impl<Ex> RefUnwindSafe for Builder<Ex>
impl<Ex> Send for Builder<Ex>
impl<Ex> Sync for Builder<Ex>
impl<Ex> Unpin for Builder<Ex>
impl<Ex> UnwindSafe for Builder<Ex>
impl<Ex: $crate::clone::Clone> Clone for Builder<Ex>
fn clone(self: &Self) -> Builder<Ex>
impl<Ex: $crate::fmt::Debug> Debug for Builder<Ex>
fn fmt(self: &Self, f: &mut $crate::fmt::Formatter<'_>) -> $crate::fmt::Result
impl<T> Any for Builder<Ex>
fn type_id(self: &Self) -> TypeId
impl<T> Borrow for Builder<Ex>
fn borrow(self: &Self) -> &T
impl<T> BorrowMut for Builder<Ex>
fn borrow_mut(self: &mut Self) -> &mut T
impl<T> CloneToUninit for Builder<Ex>
unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)
impl<T> From for Builder<Ex>
fn from(t: T) -> TReturns the argument unchanged.
impl<T> Instrument for Builder<Ex>
impl<T> ToOwned for Builder<Ex>
fn to_owned(self: &Self) -> Tfn clone_into(self: &Self, target: &mut T)
impl<T> WithSubscriber for Builder<Ex>
impl<T, U> Into for Builder<Ex>
fn into(self: Self) -> UCalls
U::from(self).That is, this conversion is whatever the implementation of
[From]<T> for Uchooses to do.
impl<T, U> TryFrom for Builder<Ex>
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
impl<T, U> TryInto for Builder<Ex>
fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>