Struct TimeoutConfig

#[non_exhaustive]
pub struct TimeoutConfig { /* private fields */ }

Top-level configuration for timeouts

Example

use aws_smithy_types::timeout::TimeoutConfig;

let timeout_config = TimeoutConfig::builder()
    .operation_timeout(Duration::from_secs(30))
    .operation_attempt_timeout(Duration::from_secs(10))
    .connect_timeout(Duration::from_secs(3))
    .build();

assert_eq!(
    timeout_config.operation_timeout(),
    Some(Duration::from_secs(30))
);
assert_eq!(
    timeout_config.operation_attempt_timeout(),
    Some(Duration::from_secs(10))
);
assert_eq!(
    timeout_config.connect_timeout(),
    Some(Duration::from_secs(3))
);

Implementations

impl TimeoutConfig

pub fn builder() -> TimeoutConfigBuilder

Returns a builder to create a TimeoutConfig.

pub fn to_builder(&self) -> TimeoutConfigBuilder

Returns a builder equivalent of this TimeoutConfig.

pub fn into_builder(self) -> TimeoutConfigBuilder

Converts this TimeoutConfig into a builder.

pub fn take_defaults_from( &mut self, other: &TimeoutConfig, ) -> &mut TimeoutConfig

Fill any unfilled values in self from other.

pub fn disabled() -> TimeoutConfig

Returns a timeout config with all timeouts disabled.

pub fn connect_timeout(&self) -> Option<Duration>

Returns this config’s connect timeout.

The connect timeout is a limit on the amount of time it takes to initiate a socket connection.

pub fn read_timeout(&self) -> Option<Duration>

Returns this config’s read timeout.

The read timeout is the limit on the amount of time it takes to read the first byte of a response from the time the request is initiated.

pub fn operation_timeout(&self) -> Option<Duration>

Returns this config’s operation timeout.

An operation represents the full request/response lifecycle of a call to a service. The operation timeout is a limit on the total amount of time it takes for an operation to be fully serviced, including the time for all retries that may have been attempted for it.

pub fn operation_attempt_timeout(&self) -> Option<Duration>

Returns this config’s operation attempt timeout.

An operation represents the full request/response lifecycle of a call to a service. When retries are enabled, then this setting makes it possible to set a timeout for individual retry attempts (including the initial attempt) for an operation.

pub fn has_timeouts(&self) -> bool

Returns true if any of the possible timeouts are set.

Trait Implementations

impl Clone for TimeoutConfig

fn clone(&self) -> TimeoutConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeoutConfig

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

Formats the value using the given formatter.

impl From<&TimeoutConfig> for OperationTimeoutConfig

fn from(cfg: &TimeoutConfig) -> OperationTimeoutConfig

Converts to this type from the input type.

impl From<TimeoutConfig> for OperationTimeoutConfig

fn from(cfg: TimeoutConfig) -> OperationTimeoutConfig

Converts to this type from the input type.

impl From<TimeoutConfig> for TimeoutConfigBuilder

fn from(timeout_config: TimeoutConfig) -> TimeoutConfigBuilder

Converts to this type from the input type.

impl PartialEq for TimeoutConfig

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

type Storer = StoreReplace<TimeoutConfig>

Specify how an item is stored in the config bag, e.g. StoreReplace and StoreAppend

impl StructuralPartialEq for TimeoutConfig