seatbelt 0.4.2

Resilience and recovery mechanisms for fallible operations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

use std::time::Duration;

/// Default timeout duration: 30 seconds.
///
/// This default provides a reasonable timeout for most service-to-service
/// communication scenarios.
const DEFAULT_TIMEOUT: Duration = Duration::from_secs(30);

/// Configuration for the timeout middleware.
///
/// This struct provides a serialization-friendly way to configure the timeout middleware
/// from external sources such as configuration files. Use [`TimeoutLayer::config`][crate::timeout::TimeoutLayer::config] to apply
/// the configuration to a timeout layer.
///
/// # Defaults
///
/// | Field | Default |
/// |-------|---------|
/// | `enabled` | `true` |
/// | `timeout` | 30 seconds |
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(any(feature = "serde", test), derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct TimeoutConfig {
    /// Whether the timeout middleware is enabled. When `false`, the middleware
    /// is bypassed and requests pass through directly to the inner service.
    pub enabled: bool,

    /// The timeout duration for operations.
    #[cfg_attr(
        any(feature = "serde", test),
        serde(with = "jiff::fmt::serde::unsigned_duration::friendly::compact::required")
    )]
    pub timeout: Duration,
}

impl Default for TimeoutConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            timeout: DEFAULT_TIMEOUT,
        }
    }
}

#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg(test)]
mod tests {
    use super::*;

    #[cfg_attr(miri, ignore)]
    #[test]
    fn default_snapshot() {
        let config = TimeoutConfig::default();
        insta::assert_json_snapshot!(config);
    }
}