cancellable 0.3.1

A Rust library providing a generic cancellable utility.
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

/// Result of a single iteration of the service loop.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum CancellationResult<T> {
    /// Indicates that the loop should continue and wraps value yielded by the
    /// finished iteration.
    Item(T),

    /// Indicates that the loop should continue.
    Continue,

    /// Indicates that the loop should end.
    Break,
}

impl<T> CancellationResult<T> {
    /// Constructs a new `CancellationResult::Item`.
    ///
    /// # Examples
    ///
    /// ```
    /// use cancellable::CancellationResult;
    ///
    /// fn construct_result() -> CancellationResult<String> {
    ///     CancellationResult::item("foo")
    /// }
    /// ```
    pub fn item(t: impl Into<T>) -> Self {
        Self::Item(t.into())
    }
}

impl<T> From<T> for CancellationResult<T> {
    fn from(value: T) -> Self {
        Self::Item(value)
    }
}