interruptible 0.2.4

Stops a future producer or stream from producing values when interrupted.
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

/// [`InterruptibleStream`] outcome that indicates whether an interruption
/// happened.
///
/// [`InterruptibleStream`]: crate::InterruptibleStream
#[derive(Debug, PartialEq, Eq)]
pub enum PollOutcome<T> {
    /// An interrupt signal was received.
    ///
    /// The item is `None` in the following cases:
    ///
    /// * The interruption happened before the stream was polled.
    /// * The interruption happened after a `Poll::Ready`, but before a
    ///   subsequent poll.
    Interrupted(Option<T>),
    /// No interrupt signal was received.
    NoInterrupt(T),
}

#[cfg(test)]
mod tests {
    use super::PollOutcome;

    #[test]
    fn debug() {
        assert_eq!(
            "Interrupted(Some(1))",
            format!("{:?}", PollOutcome::Interrupted(Some(1)))
        );
    }
}