Struct HttpClientPolicy 

#[non_exhaustive]
pub struct HttpClientPolicy { /* private fields */ }

Shared HTTP client policy used by transport-owning crates.

Implementations

impl HttpClientPolicy

pub fn new(user_agent: impl Into<String>) -> Result<Self, ValidationError>

Creates a policy with the default timeout and a validated user agent.

Errors

Returns ValidationError if the user agent is empty or cannot be encoded as an HTTP header value.

pub fn with_timeout_and_user_agent( timeout: Duration, user_agent: impl Into<String>, ) -> Result<Self, ValidationError>

Creates a policy with an explicit timeout and validated user agent.

Errors

Returns ValidationError if the user agent is empty or cannot be encoded as an HTTP header value.

pub const fn without_timeout(self) -> Self

Returns a copy of this policy with timeouts disabled.

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

Returns a copy of this policy with the supplied timeout.

pub const fn with_max_response_bytes(self, max_response_bytes: usize) -> Self

Returns a copy of this policy with the supplied maximum response-body size, in bytes. The HTTP transport refuses to buffer a response whose decoded body would exceed this many bytes.

pub fn try_with_user_agent( self, user_agent: impl Into<String>, ) -> Result<Self, ValidationError>

Returns a copy of this policy with a newly validated user agent.

Errors

Returns ValidationError if the user agent is empty or cannot be encoded as an HTTP header value.

pub const fn timeout(&self) -> Option<Duration>

Returns the configured timeout, if one is enabled.

pub const fn max_response_bytes(&self) -> usize

Returns the configured maximum response-body size, in bytes.

pub fn user_agent(&self) -> &str

Returns the configured user-agent header value.

Trait Implementations

impl Clone for HttpClientPolicy

fn clone(&self) -> HttpClientPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpClientPolicy

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

Formats the value using the given formatter.

impl Eq for HttpClientPolicy

impl PartialEq for HttpClientPolicy

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpClientPolicy