Struct CollectOptions 

pub struct CollectOptions { /* private fields */ }

Available on crate feature http only.

Options for BodyExt::collect_with: an optional size cap and/or timeout.

When either bound is hit the collect stops with a CollectError that still carries the bytes read so far and the unread remainder, so the original body can be reassembled and forwarded untouched.

This is the soft, recoverable counterpart to Limited, which hard-fails and discards the body the moment its limit is crossed.

Implementations

impl CollectOptions

pub const fn new() -> CollectOptions

Create empty options (no cap, no timeout) — equivalent to a plain collect that also retains read bytes on a stream error.

pub fn with_max_size(self, max_size: usize) -> CollectOptions

Cap the number of bytes buffered. When reached, collecting stops with CollectErrorKind::CapReached; the bytes up to the cap are read and the remainder stays forwardable.

pub fn set_max_size(&mut self, max_size: usize) -> &mut CollectOptions

Cap the number of bytes buffered. When reached, collecting stops with CollectErrorKind::CapReached; the bytes up to the cap are read and the remainder stays forwardable.

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

Cap the time spent collecting. When elapsed, collecting stops with CollectErrorKind::TimedOut; whatever was read is kept and the remainder stays forwardable.

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

Cap the time spent collecting. When elapsed, collecting stops with CollectErrorKind::TimedOut; whatever was read is kept and the remainder stays forwardable.

Trait Implementations

impl Clone for CollectOptions

fn clone(&self) -> CollectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectOptions

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

Formats the value using the given formatter.

impl Default for CollectOptions

fn default() -> CollectOptions

Returns the “default value” for a type.