base-scheduler 0.4.0

Explicit, runtime-independent scheduler capabilities for protocol libraries
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

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

use crate::OperationError;
use std::fmt;

/// Failure of a clock timeout, separate from the wrapped operation's own output.
#[derive(Debug)]
pub enum TimeoutError {
    /// The operation was still pending when its timer completed.
    Elapsed,
    /// The timer failed before the operation completed.
    Clock(OperationError),
}

impl fmt::Display for TimeoutError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Elapsed => formatter.write_str("operation timed out"),
            Self::Clock(error) => write!(formatter, "timeout clock failed: {error}"),
        }
    }
}

impl std::error::Error for TimeoutError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Elapsed => None,
            Self::Clock(error) => Some(error),
        }
    }
}