http_extensions 0.2.1

Shared HTTP types and extension traits for clients and servers.
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
61
62
63
64

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

//! Resilience helpers for HTTP workloads.

use std::io::ErrorKind;

use recoverable::RecoveryInfo;

/// Detects if an IO error kind is recoverable.
///
/// This is opinionated detection based on common transient IO error kinds.
// TODO: should this be moved to recoverable crate?
#[must_use]
pub(crate) fn detect_io_recovery(kind: ErrorKind) -> RecoveryInfo {
    match kind {
        ErrorKind::WouldBlock
        | ErrorKind::TimedOut
        | ErrorKind::ConnectionReset
        | ErrorKind::ConnectionAborted
        | ErrorKind::NotConnected
        | ErrorKind::ConnectionRefused
        | ErrorKind::AddrInUse
        | ErrorKind::AddrNotAvailable
        | ErrorKind::BrokenPipe
        | ErrorKind::Interrupted => RecoveryInfo::retry(),
        _ => RecoveryInfo::never(),
    }
}

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

    #[test]
    fn detect_io_recovery_never() {
        // Test some non-retryable ErrorKinds
        assert_eq!(detect_io_recovery(ErrorKind::NotFound), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::PermissionDenied), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::AlreadyExists), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::InvalidData), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::InvalidInput), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::UnexpectedEof), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::WriteZero), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::Unsupported), RecoveryInfo::never());
        assert_eq!(detect_io_recovery(ErrorKind::OutOfMemory), RecoveryInfo::never());
    }

    #[test]
    fn detect_io_recovery_retry() {
        // Test all retryable ErrorKinds
        assert_eq!(detect_io_recovery(ErrorKind::WouldBlock), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::TimedOut), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::ConnectionReset), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::ConnectionAborted), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::NotConnected), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::ConnectionRefused), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::AddrInUse), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::AddrNotAvailable), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::BrokenPipe), RecoveryInfo::retry());
        assert_eq!(detect_io_recovery(ErrorKind::Interrupted), RecoveryInfo::retry());
    }
}