Enum object_store::ClientConfigKey

#[non_exhaustive]
pub enum ClientConfigKey {
    AllowHttp,
    AllowInvalidCertificates,
    ConnectTimeout,
    DefaultContentType,
    Http1Only,
    Http2KeepAliveInterval,
    Http2KeepAliveTimeout,
    Http2KeepAliveWhileIdle,
    Http2Only,
    PoolIdleTimeout,
    PoolMaxIdlePerHost,
    ProxyUrl,
    ProxyCaCertificate,
    ProxyExcludes,
    Timeout,
    UserAgent,
}

Configuration keys for ClientOptions

Variants (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

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

ConnectTimeout

Timeout for only the connect phase of a Client

DefaultContentType

default CONTENT_TYPE for uploads

Http1Only

Only use http1 connections

Http2KeepAliveInterval

Interval for HTTP2 Ping frames should be sent to keep a connection alive.

Http2KeepAliveTimeout

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

Http2KeepAliveWhileIdle

Enable HTTP2 keep alive pings for idle connections

Http2Only

Only use http2 connections

PoolIdleTimeout

The pool max idle timeout

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

PoolMaxIdlePerHost

maximum number of idle connections per host

ProxyUrl

HTTP proxy to use for requests

ProxyCaCertificate

PEM-formatted CA certificate for proxy connections

ProxyExcludes

List of hosts that bypass proxy

Timeout

Request timeout

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

UserAgent

User-Agent header to be used by this client

Trait Implementations

impl AsRef<str> for ClientConfigKey

fn as_ref(&self) -> &str

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

impl Clone for ClientConfigKey

fn clone(&self) -> ClientConfigKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfigKey

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for ClientConfigKey

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for ClientConfigKey

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClientConfigKey

fn eq(&self, other: &ClientConfigKey) -> 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 Serialize for ClientConfigKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ClientConfigKey

impl Eq for ClientConfigKey

impl StructuralPartialEq for ClientConfigKey