bitcoin-sock 0.1.19

Low-level, cross-platform RAII wrapper and utilities for raw OS sockets, mirroring Bitcoin Core networking semantics (send/recv, timeouts, readiness, error classification).
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

// ---------------- [ File: bitcoin-sock/src/io_error_is_permanent.rs ]
crate::ix!();

#[cfg(unix)]
#[inline]
pub fn io_error_is_permanent(err: i32) -> bool {
    use libc::{EAGAIN, EINTR, EWOULDBLOCK, EINPROGRESS};

    // Errors considered *transient* by the original C++ implementation.
    // Anything else is treated as permanent.
    let permanent = !(err == EAGAIN
        || err == EINTR
        || err == EWOULDBLOCK
        || err == EINPROGRESS);

    trace!(
        error_code = err,
        permanent,
        "Checked if I/O error is permanent (unix)"
    );
    permanent
}

#[cfg(windows)]
#[inline]
pub fn io_error_is_permanent(err: i32) -> bool {
    use winapi::um::winsock2::{WSAEAGAIN, WSAEINTR, WSAEWOULDBLOCK, WSAEINPROGRESS};

    let permanent = !(err == WSAEAGAIN
        || err == WSAEINTR
        || err == WSAEWOULDBLOCK
        || err == WSAEINPROGRESS);

    trace!(
        error_code = err,
        permanent,
        "Checked if I/O error is permanent (windows)"
    );
    permanent
}

// -----------------------------------------------------------------------------
// Specification
// -----------------------------------------------------------------------------
#[cfg(test)]
mod io_error_is_permanent_spec {
    use super::*;

    #[traced_test]
    fn recognises_transient_and_permanent_errors() {
        serialize_fds!(); // <— add this

        #[cfg(unix)]
        {
            use libc::{
                EAGAIN, EINTR, EWOULDBLOCK, EINPROGRESS, ECONNREFUSED, ECONNRESET, ETIMEDOUT,
            };

            // Exact set from the reference implementation.
            for code in [EAGAIN, EINTR, EWOULDBLOCK, EINPROGRESS] {
                assert!(
                    !io_error_is_permanent(code),
                    "expected {code} to be non‑permanent"
                );
            }

            // Representative permanent errors.
            for code in [ECONNREFUSED, ECONNRESET, ETIMEDOUT] {
                assert!(
                    io_error_is_permanent(code),
                    "expected {code} to be permanent"
                );
            }
        }

        #[cfg(windows)]
        {
            use winapi::um::winsock2::{
                WSAEAGAIN, WSAEINTR, WSAEWOULDBLOCK, WSAEINPROGRESS, WSAECONNREFUSED,
                WSAECONNRESET, WSAETIMEDOUT,
            };

            for code in [WSAEAGAIN, WSAEINTR, WSAEWOULDBLOCK, WSAEINPROGRESS] {
                assert!(
                    !io_error_is_permanent(code),
                    "expected {code} to be non‑permanent"
                );
            }

            for code in [WSAECONNREFUSED, WSAECONNRESET, WSAETIMEDOUT] {
                assert!(
                    io_error_is_permanent(code),
                    "expected {code} to be permanent"
                );
            }
        }

        info!("All io_error_is_permanent contract checks passed");
    }
}