asygnal 0.0.2

[WIP] Async-first signal handling, such as ctrl-c.
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
45
46
47
48
49
50

//! Unix-specific functionality.

use std::task::{Context, Poll};

mod signal_kind;
mod signal_set;

// Required when documenting on non-Unix platforms.
#[cfg(not(unix))]
mod libc_polyfill;

#[doc(inline)]
pub use self::{signal_kind::*, signal_set::*};

/// A future for receiving a particular signal.
#[derive(Debug)]
pub struct Signal {
    _private: (),
}

impl Signal {
    /// Receive the next signal notification event.
    #[inline]
    pub async fn recv(&mut self) -> Option<SignalKind> {
        crate::util::poll_fn(|cx| self.poll_recv(cx)).await
    }

    /// Poll to receive the next signal notification event, outside of an
    /// `async` context.
    pub fn poll_recv(
        &mut self,
        _cx: &mut Context<'_>,
    ) -> Poll<Option<SignalKind>> {
        unimplemented!()
    }
}

cfg_stream! {
    impl futures::stream::Stream for Signal {
        type Item = SignalKind;

        #[inline]
        fn poll_next(
            mut self: std::pin::Pin<&mut Self>,
            cx: &mut Context<'_>
        ) -> Poll<Option<SignalKind>> {
            self.poll_recv(cx)
        }
    }
}