timerwheel 0.1.0

Hierarchical timer wheel for delayed task scheduling with pluggable executors.
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

// Copyright © 2026-present The Timerwheel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::fmt;

/// Result type returned by timerwheel APIs.
pub type Result<T> = std::result::Result<T, Error>;

/// Error values returned by timer and executor operations.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Error {
    /// The timer or executor is closed.
    Closed,
    /// A bounded queue or pending-timeout limit is saturated.
    Saturated,
    /// A builder value is invalid.
    InvalidConfig(&'static str),
    /// A blocking operation reached its timeout.
    TimedOut,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Closed => f.write_str("timerwheel is closed"),
            Self::Saturated => f.write_str("timerwheel capacity is saturated"),
            Self::InvalidConfig(message) => write!(f, "invalid configuration: {message}"),
            Self::TimedOut => f.write_str("operation timed out"),
        }
    }
}

impl std::error::Error for Error {}