Struct Http1BodyDrainConfig 

pub struct Http1BodyDrainConfig {
    pub max_bytes: usize,
    pub timeout: Duration,
    pub max_concurrent: NonZero<usize>,
}

Available on crate features dns and http-backend and http and std and tcp only.

Configuration of the bounded background draining of HTTP/1 response bodies that were dropped before their end.

An HTTP/1 connection can only be reused once the previous response body was read off the wire. When a response from a pooled HTTP/1 connection is dropped with its body unread or partially read, the remainder is read and discarded by a background task, within these bounds, so the connection can return to the pool instead of being closed. While it drains, the connection stays checked out: requests meanwhile are served as the pool’s saturation policy decides (another connection, or waiting for one). A successful drain makes the connection available to later requests; it does not reserve it for the next one.

A drain gives up, closing the connection as without draining, once:

• more than max_bytes payload bytes were discarded with more of the body left. The body is read a frame at a time, so the last frame read may cross the limit: this bounds the reads, not exactly the bytes read off the socket. A body ending at exactly max_bytes drains, as does one whose final frame crosses it;
• timeout elapsed since the body was dropped, including the time waiting to be scheduled;
• the body fails (truncated or malformed framing), or the executor shuts down.

Draining only starts if fewer than max_concurrent drains run for the same connector (shared by its clones); otherwise the connection is closed right away. A zero max_bytes or timeout never drains a body that has bytes left.

This only applies to HTTP/1 responses whose connection could be reused: not after a Connection: close (sent or received), for close-delimited bodies, upgrades or successful CONNECT tunnels, nor for connections otherwise known broken or not reusable. HTTP/2 and HTTP/3 cancel the stream of a dropped body instead, keeping the connection.

Draining needs the tokio runtime of the connection: a body dropped outside of one is not drained.

Fields

max_bytes: usize

At most this many unread payload bytes (before content decoding) are discarded to recover a connection: 1 MiB by default.

timeout: Duration

A drain gives up this long after the body was dropped: 50 ms by default.

max_concurrent: NonZero<usize>

At most this many drains run at once per connector: 256 by default.

Implementations

impl Http1BodyDrainConfig

pub const fn new() -> Http1BodyDrainConfig

Create a new Http1BodyDrainConfig with the default limits.

pub fn with_max_bytes(self, max: usize) -> Http1BodyDrainConfig

Discard at most this many unread payload bytes to recover a connection.

pub fn set_max_bytes(&mut self, max: usize) -> &mut Http1BodyDrainConfig

Discard at most this many unread payload bytes to recover a connection.

pub fn with_timeout(self, timeout: Duration) -> Http1BodyDrainConfig

Give up a drain this long after its body was dropped.

pub fn set_timeout(&mut self, timeout: Duration) -> &mut Http1BodyDrainConfig

Give up a drain this long after its body was dropped.

pub fn with_max_concurrent(self, max: NonZero<usize>) -> Http1BodyDrainConfig

Run at most this many drains at once per connector.

pub fn set_max_concurrent( &mut self, max: NonZero<usize>, ) -> &mut Http1BodyDrainConfig

Run at most this many drains at once per connector.

Trait Implementations

impl Clone for Http1BodyDrainConfig

fn clone(&self) -> Http1BodyDrainConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Http1BodyDrainConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Http1BodyDrainConfig

fn default() -> Http1BodyDrainConfig

Returns the “default value” for a type.

impl Eq for Http1BodyDrainConfig

impl PartialEq for Http1BodyDrainConfig

fn eq(&self, other: &Http1BodyDrainConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Http1BodyDrainConfig