Struct ClientConfig 

#[non_exhaustive]
pub struct ClientConfig {
    pub url_policy: UrlPolicy,
    pub timeout: Duration,
    pub retry: RetryPolicy,
    pub validate_outgoing: bool,
}

Available on crate feature client only.

How the client behaves.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url_policy: UrlPolicy

What this client is willing to send a request to. Defaults to HTTPS, no private networks.

timeout: Duration

How long one request may take.

retry: RetryPolicy

How GET requests are retried. Writes are never retried.

validate_outgoing: bool

Whether objects are validated before being sent. Defaults to true.

This is what makes “construct strictly” hold in practice: the infallible From<&str> conversions the builders use are lenient, so the guarantee lives here, at the wire, where it also catches the cross-field rules no constructor could.

Implementations

impl ClientConfig

pub fn for_testing() -> Self

A configuration for talking to a peer on localhost, as an integration test does.

pub fn with_url_policy(self, policy: UrlPolicy) -> Self

Sets the URL policy.

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

Sets the per-request timeout.

pub const fn without_outgoing_validation(self) -> Self

Turns off validation of outgoing objects.

Only reasonable when a peer is known to require something non-conformant, and then it is better to record the reason next to the call.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.