Struct ClientOptions 

pub struct ClientOptions { /* private fields */ }

HTTP client configuration for remote object stores

Implementations

impl ClientOptions

pub fn new() -> Self

Create a new ClientOptions with default values

pub fn with_config(self, key: ClientConfigKey, value: impl Into<String>) -> Self

Set an option by key

pub fn get_config_value(&self, key: &ClientConfigKey) -> Option<String>

Get an option by key

pub fn with_user_agent(self, agent: HeaderValue) -> Self

Sets the User-Agent header to be used by this client

Default is based on the version of this crate

pub fn with_root_certificate(self, certificate: Certificate) -> Self

Add a custom root certificate.

This can be used to connect to a server that has a self-signed certificate for example.

pub fn with_default_content_type(self, mime: impl Into<String>) -> Self

Set the default Content-Type for uploads

pub fn with_content_type_for_suffix( self, extension: impl Into<String>, mime: impl Into<String>, ) -> Self

Set the Content-Type for a given file extension

pub fn with_default_headers(self, headers: HeaderMap) -> Self

Sets the default headers for every request

pub fn with_allow_http(self, allow_http: bool) -> Self

Sets what protocol is allowed.

If allow_http is :

• false (default): Only HTTPS is allowed
• true: HTTP and HTTPS are allowed

pub fn with_allow_invalid_certificates(self, allow_insecure: bool) -> Self

Allows connections to invalid SSL certificates

If allow_invalid_certificates is :

• false (default): Only valid HTTPS certificates are allowed
• true: All HTTPS certificates are allowed

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

pub fn with_http1_only(self) -> Self

Only use HTTP/1 connections (default)

See Also

• Self::with_http2_only if you only want to use HTTP/2
• Self::with_allow_http2 if you want to use HTTP/1 or HTTP/2

HTTP/2 is not used by default. See details [#104](https://github.com/apache/arrow-rs-object-store/issues/104)

pub fn with_http2_only(self) -> Self

Only use HTTP/2 connections

See Also

• Self::with_http1_only if you only want to use HTTP/1
• Self::with_allow_http2 if you want to use HTTP/1 or HTTP/2

HTTP/2 is not used by default. See details [#104](https://github.com/apache/arrow-rs-object-store/issues/104)

pub fn with_allow_http2(self) -> Self

Use HTTP/2 if supported, otherwise use HTTP/1.

See Also

• Self::with_http1_only if you only want to use HTTP/1
• Self::with_http2_only if you only want to use HTTP/2

HTTP/2 is not used by default. See details [#104](https://github.com/apache/arrow-rs-object-store/issues/104)

pub fn with_proxy_url(self, proxy_url: impl Into<String>) -> Self

Set a proxy URL to use for requests

pub fn with_proxy_ca_certificate( self, proxy_ca_certificate: impl Into<String>, ) -> Self

Set a trusted proxy CA certificate

pub fn with_proxy_excludes(self, proxy_excludes: impl Into<String>) -> Self

Set a list of hosts to exclude from proxy connections

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

Set timeout for the overall request

The timeout starts from when the request starts connecting until the response body has finished. If the request does not complete within the timeout, the client returns a timeout error.

Timeout errors are retried, subject to the RetryConfig

Default is 30 seconds

See Also

• Self::with_timeout_disabled to disable the timeout
• Self::with_connect_timeout to set a timeout for the connect phase

pub fn with_timeout_disabled(self) -> Self

Disables the request timeout

See Also

• Self::with_timeout

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

Set a timeout for only the connect phase of a Client

This is the time allowed for the client to establish a connection and if the connection is not established within this time, the client returns a timeout error.

Timeout errors are retried, subject to the RetryConfig

Default is 5 seconds

See Also

• Self::with_timeout to set a timeout for the overall request
• Self::with_connect_timeout_disabled to disable the connect timeout

pub fn with_connect_timeout_disabled(self) -> Self

Disables the connection timeout

See Also

• Self::with_connect_timeout

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

Set the pool max idle timeout

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

Default is 90 seconds enforced by reqwest

pub fn with_pool_max_idle_per_host(self, max: usize) -> Self

Set the maximum number of idle connections per host

Default is no limit enforced by reqwest

pub fn with_http2_keep_alive_interval(self, interval: Duration) -> Self

Sets an interval for HTTP/2 Ping frames should be sent to keep a connection alive.

Default is disabled enforced by reqwest

pub fn with_http2_keep_alive_timeout(self, interval: Duration) -> Self

Sets a timeout for receiving an acknowledgement of the keep-alive ping.

If the ping is not acknowledged within the timeout, the connection will be closed. Does nothing if http2_keep_alive_interval is disabled.

Default is disabled enforced by reqwest

pub fn with_http2_keep_alive_while_idle(self) -> Self

Enable HTTP/2 keep alive pings for idle connections

If disabled, keep-alive pings are only sent while there are open request/response streams. If enabled, pings are also sent when no streams are active

Default is disabled enforced by reqwest

pub fn with_http2_max_frame_size(self, sz: u32) -> Self

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

Default is currently 16,384 but may change internally to optimize for common uses.

pub fn get_default_headers(&self) -> Option<&HeaderMap>

Get the default headers defined through ClientOptions::with_default_headers

pub fn get_content_type(&self, path: &Path) -> Option<&str>

Get the mime type for the file in path to be uploaded

Gets the file extension from path, and returns the mime type if it was defined initially through ClientOptions::with_content_type_for_suffix

Otherwise, returns the default mime type if it was defined earlier through ClientOptions::with_default_content_type

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> Self

Returns the “default value” for a type.