base-scheduler 0.3.1

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
33
34

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

use std::{fmt, io};

/// Blocking work could not be admitted. Job completion separately reports `TaskError`.
#[derive(Debug)]
pub enum BlockingError {
    /// Cancellation was requested before the closure was admitted.
    Cancelled,
    /// The scheduler no longer admits blocking work.
    SchedulerClosed,
    /// The dedicated pool could not start its worker threads.
    Io(io::Error),
}

impl fmt::Display for BlockingError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Cancelled => formatter.write_str("blocking admission cancelled"),
            Self::SchedulerClosed => formatter.write_str("the scheduler is closed"),
            Self::Io(error) => error.fmt(formatter),
        }
    }
}

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