Struct ClientConfig 

#[non_exhaustive]
pub struct ClientConfig {
    pub endpoint: String,
    pub timeout: Duration,
    pub max_concurrent_requests: usize,
    pub connect_timeout: Duration,
    pub pool_idle_timeout: Duration,
    pub pool_max_idle_per_host: usize,
    pub tcp_keepalive: Option<Duration>,
    pub signature_version: SignatureVersion,
    /* private fields */
}

Configuration for the STS client.

Use ClientConfig::default() to create a new configuration, then use the with_* methods to customize.

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.

endpoint: String

STS API endpoint URL.

timeout: Duration

HTTP request timeout.

max_concurrent_requests: usize

Maximum number of concurrent API requests.

connect_timeout: Duration

Connection timeout for establishing TCP connections.

pool_idle_timeout: Duration

Pool idle timeout before closing idle connections.

pool_max_idle_per_host: usize

Maximum number of idle connections per host.

tcp_keepalive: Option<Duration>

TCP keepalive duration.

signature_version: SignatureVersion

Signature version to use for API requests.

Implementations

impl ClientConfig

pub fn with_endpoint(self, endpoint: impl Into<String>) -> Self

Creates a new configuration with a custom endpoint.

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

Sets the HTTP request timeout.

Arguments

• timeout - The timeout duration for HTTP requests

Example

let config = ClientConfig::default().with_timeout(Duration::from_secs(60));

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

Sets the maximum number of concurrent API requests.

This limit helps prevent overwhelming the server and manages resource usage. When the limit is reached, additional requests will wait until a slot becomes available.

Arguments

• max - Maximum number of concurrent requests (must be > 0)

Panics

Panics if max is 0.

Example

let config = ClientConfig::default().with_max_concurrent_requests(5);

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

Sets the connection timeout for establishing TCP connections.

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

Sets the pool idle timeout before closing idle connections.

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

Sets the maximum number of idle connections per host.

pub fn with_tcp_keepalive(self, duration: Option<Duration>) -> Self

Sets the TCP keepalive duration. Use None to disable.

pub fn with_signature_version(self, version: SignatureVersion) -> Self

Sets the signature version to use for API requests.

Arguments

• version - The signature version (V1_0 for SHA-1, V2_0 for SHA-256)

Example

let config = ClientConfig::default()
    .with_signature_version(SignatureVersion::V2_0);

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.