Struct TimeoutConfig 

pub struct TimeoutConfig {
    pub backoff: BackoffInterval,
    pub quantile: f64,
    pub safety_factor: f64,
}

Configuration for AdaptiveTimeout.

The struct fits in 24 bytes.

Example

use adaptive_timeout::TimeoutConfig;

let config = TimeoutConfig {
    quantile: 0.999,
    safety_factor: 3.0,
    ..TimeoutConfig::default()
};

Fields

backoff: BackoffInterval

Timeout floor and ceiling. Default: 250ms..1min.

quantile: f64

Quantile of the latency distribution to use (e.g. 0.9999 for P99.99). Default: 0.9999.

safety_factor: f64

Multiplier applied to the quantile estimate. A factor of 2.0 means the timeout is twice the observed quantile. Default: 2.0.

Implementations

impl TimeoutConfig

pub fn min_timeout(&self) -> Duration

Returns the minimum timeout as a Duration.

pub fn max_timeout(&self) -> Duration

Returns the maximum timeout as a Duration.

Trait Implementations

impl Clone for TimeoutConfig

fn clone(&self) -> TimeoutConfig

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for TimeoutConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<BackoffInterval> for TimeoutConfig

Convert a BackoffInterval into a TimeoutConfig.

Quantile and safety factor remain at defaults.

fn from(backoff: BackoffInterval) -> Self

Converts to this type from the input type.

impl FromStr for TimeoutConfig

Parse a TimeoutConfig from a duration-range string.

The string is parsed as a BackoffInterval; quantile and safety_factor are left at their defaults.

Example

use adaptive_timeout::TimeoutConfig;

let cfg: TimeoutConfig = "10ms..60s".parse().unwrap();
assert_eq!(cfg.backoff.min_ms.get(), 10);
assert_eq!(cfg.backoff.max_ms.get(), 60_000);
assert_eq!(cfg.quantile, 0.9999);
assert_eq!(cfg.safety_factor, 2.0);

type Err = ParseError

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 Copy for TimeoutConfig