Struct aws_config::timeout::Config

pub struct Config {
    pub api: Api,
    pub http: Http,
    pub tcp: Tcp,
}

Top-level configuration for timeouts

Example

use aws_smithy_types::{timeout, tristate::TriState};

let api_timeouts = timeout::Api::new()
    .with_call_timeout(TriState::Set(Duration::from_secs(2)))
    .with_call_attempt_timeout(TriState::Set(Duration::from_secs_f32(0.5)));
let timeout_config = timeout::Config::new()
    .with_api_timeouts(api_timeouts);

assert_eq!(
    timeout_config.api.call_timeout(),
    TriState::Set(Duration::from_secs(2))
);

assert_eq!(
    timeout_config.api.call_attempt_timeout(),
    TriState::Set(Duration::from_secs_f32(0.5))
);

Fields

api: Api

API timeouts used by Smithy Clients

http: Http

HTTP timeouts used by DynConnectors

tcp: Tcp

TCP timeouts used by lower-level DynConnectors

Implementations

impl Config

pub fn new() -> Config

Create a new Config with no timeouts set

pub fn api_timeouts(&self) -> Api

Return the API-related timeouts from this config

pub fn http_timeouts(&self) -> Http

Return the API-related timeouts from this config

pub fn tcp_timeouts(&self) -> Tcp

Return the API-related timeouts from this config

pub fn with_api_timeouts(self, timeouts: Api) -> Config

Consume an Config to create a new one, setting the API-related timeouts

pub fn with_http_timeouts(self, timeouts: Http) -> Config

Consume a Config to create a new one, setting HTTP-related timeouts

pub fn with_tcp_timeouts(self, timeouts: Tcp) -> Config

Consume a Config to create a new one, setting TCP-related timeouts

pub fn take_unset_from(self, other: Config) -> Config

Merges two timeout configs together.

Values from other will only be used as a fallback for values from self. Useful for merging configs from different sources together when you want to handle “precedence” per value instead of at the config level

Example

let a = timeout::Config::new().with_api_timeouts(
    timeout::Api::new().with_call_timeout(TriState::Set(Duration::from_secs(2)))
);
let b = timeout::Config::new().with_api_timeouts(
    timeout::Api::new().with_call_attempt_timeout(TriState::Set(Duration::from_secs(3)))
);
let timeout_config = a.take_unset_from(b);
// A's value take precedence over B's value
assert_eq!(timeout_config.api.call_timeout(), TriState::Set(Duration::from_secs(2)));
// A never set a connect timeout so B's value was used
assert_eq!(timeout_config.api.call_attempt_timeout(), TriState::Set(Duration::from_secs(3)));

pub fn has_timeouts(&self) -> bool

Returns true if any of the possible timeouts are set

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl From<Config> for Api

fn from(config: Config) -> Api

Converts to this type from the input type.

impl From<Config> for Http

fn from(config: Config) -> Http

Converts to this type from the input type.

impl From<Config> for Tcp

fn from(config: Config) -> Tcp

Converts to this type from the input type.

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Config