Skip to main content

ClientConfigKey

Enum ClientConfigKey 

Source
#[non_exhaustive]
pub enum ClientConfigKey {
Show 18 variants AllowHttp, AllowInvalidCertificates, ConnectTimeout, DefaultContentType, Http1Only, Http2KeepAliveInterval, Http2KeepAliveTimeout, Http2KeepAliveWhileIdle, Http2MaxFrameSize, Http2Only, PoolIdleTimeout, PoolMaxIdlePerHost, ProxyUrl, ProxyCaCertificate, ProxyExcludes, RandomizeAddresses, Timeout, UserAgent,
}
Expand description

Configuration keys for ClientOptions

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AllowHttp

Allow non-TLS, i.e. non-HTTPS connections

Supported keys:

  • allow_http
§

AllowInvalidCertificates

Skip certificate validation on https connections.

Warning

You should think very carefully before using this method. If invalid certificates are trusted, any certificate for any site will be trusted for use. This includes expired certificates. This introduces significant vulnerabilities, and should only be used as a last resort or for testing

Supported keys:

  • allow_invalid_certificates
§

ConnectTimeout

Timeout for only the connect phase of a Client

Supported keys:

  • connect_timeout
§

DefaultContentType

default Content-Type for uploads

Supported keys:

  • default_content_type
§

Http1Only

Only use HTTP/1 connections

Supported keys:

  • http1_only
§

Http2KeepAliveInterval

Interval for HTTP/2 Ping frames should be sent to keep a connection alive.

Supported keys:

  • http2_keep_alive_interval
§

Http2KeepAliveTimeout

Timeout for receiving an acknowledgement of the keep-alive ping.

Supported keys:

  • http2_keep_alive_timeout
§

Http2KeepAliveWhileIdle

Enable HTTP/2 keep alive pings for idle connections

Supported keys:

  • http2_keep_alive_while_idle
§

Http2MaxFrameSize

Sets the maximum frame size to use for HTTP/2.

Supported keys:

  • http2_max_frame_size
§

Http2Only

Only use HTTP/2 connections

Supported keys:

  • http2_only
§

PoolIdleTimeout

The pool max idle timeout

This is the length of time an idle connection will be kept alive

Supported keys:

  • pool_idle_timeout
§

PoolMaxIdlePerHost

maximum number of idle connections per host

Supported keys:

  • pool_max_idle_per_host
§

ProxyUrl

HTTP proxy to use for requests

Supported keys:

  • proxy_url
§

ProxyCaCertificate

PEM-formatted CA certificate for proxy connections

Supported keys:

  • proxy_ca_certificate
§

ProxyExcludes

List of hosts that bypass proxy

Supported keys:

  • proxy_excludes
§

RandomizeAddresses

Randomize order addresses that the DNS resolution yields.

This will spread the connections across more servers.

Warning

This will override the DNS resolver configured by reqwest.

Supported keys:

  • randomize_addresses
§

Timeout

Request timeout

The timeout is applied from when the request starts connecting until the response body has finished

Supported keys:

  • timeout
§

UserAgent

User-Agent header to be used by this client

Supported keys:

  • user_agent

Trait Implementations§

Source§

impl AsRef<str> for ClientConfigKey

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for ClientConfigKey

Source§

fn clone(&self) -> ClientConfigKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientConfigKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ClientConfigKey

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl FromStr for ClientConfigKey

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for ClientConfigKey

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ClientConfigKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ClientConfigKey

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for ClientConfigKey

Source§

impl Eq for ClientConfigKey

Source§

impl StructuralPartialEq for ClientConfigKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,