evdevil 0.4.1

Bindings to Linux' input device APIs: evdev and uinput
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

#![cfg(any(feature = "tokio", feature = "async-io"))]

#[cfg(all(not(doc), feature = "tokio", feature = "async-io"))]
compile_error!("`tokio` and `async-io` are mutually exclusive; only one may be enabled");

use std::{io, os::fd::AsRawFd, task::Poll};

use crate::{EventReader, event::InputEvent, reader::Report, util::r#async::AsyncHelper};

/// An asynchronous iterator over [`Report`]s emitted by the device.
///
/// Returned by [`EventReader::async_reports`].
///
/// Note that this type does not yet implement the `AsyncIterator` trait, since that is still
/// unstable.
/// To fetch [`Report`]s, use [`AsyncReports::next_report`].
#[derive(Debug)]
pub struct AsyncReports<'a> {
    helper: AsyncHelper,
    reader: &'a mut EventReader,
}

impl<'a> AsyncReports<'a> {
    pub(crate) fn new(reader: &'a mut EventReader) -> io::Result<Self> {
        Ok(Self {
            helper: AsyncHelper::new(reader.as_raw_fd())?,
            reader,
        })
    }

    /// Asynchronously fetches the next [`Report`] from the device.
    ///
    /// When using the `"tokio"` feature, this method must be called from within a tokio context.
    pub async fn next_report(&mut self) -> io::Result<Report> {
        self.helper
            .asyncify(|| match self.reader.reports().next() {
                Some(res) => Poll::Ready(res),
                None => Poll::Pending,
            })
            .await
    }
}

/// An asynchronous iterator over [`InputEvent`]s produced by an [`EventReader`].
///
/// Returned by [`EventReader::async_events`].
///
/// Note that this type does not yet implement the `AsyncIterator` trait, since that is still
/// unstable.
/// To fetch [`InputEvent`]s, use [`AsyncEvents::next_event`].
#[derive(Debug)]
pub struct AsyncEvents<'a> {
    helper: AsyncHelper,
    reader: &'a mut EventReader,
}

impl<'a> AsyncEvents<'a> {
    pub(crate) fn new(reader: &'a mut EventReader) -> io::Result<Self> {
        Ok(Self {
            helper: AsyncHelper::new(reader.as_raw_fd())?,
            reader,
        })
    }

    /// Asynchronously fetches the next [`InputEvent`] from the [`EventReader`].
    ///
    /// When using the `"tokio"` feature, this method must be called from within a tokio context.
    pub async fn next_event(&mut self) -> io::Result<InputEvent> {
        self.helper
            .asyncify(|| match self.reader.events().next() {
                Some(res) => Poll::Ready(res),
                None => Poll::Pending,
            })
            .await
    }
}

#[cfg(test)]
mod tests {
    use std::io;

    use crate::{
        event::{Rel, RelEvent, Syn},
        test::{check_events, pair},
        util::r#async::test::AsyncTest,
    };

    #[test]
    fn smoke() -> io::Result<()> {
        let (uinput, evdev) = pair(|b| b.with_rel_axes([Rel::DIAL]))?;
        let mut reader = evdev.into_reader()?;

        {
            let event = AsyncTest::new(async { reader.async_events()?.next_event().await }, || {
                uinput.write(&[RelEvent::new(Rel::DIAL, 1).into()])
            })
            .run()?;

            check_events([event], [RelEvent::new(Rel::DIAL, 1).into()]);
        }

        let ev = reader.events().next().unwrap()?;
        check_events([ev], [Syn::REPORT.into()]);

        let report = AsyncTest::new(
            async { reader.async_reports()?.next_report().await },
            || uinput.write(&[RelEvent::new(Rel::DIAL, 2).into()]),
        )
        .run()?;

        assert_eq!(report.len(), 2);
        check_events(
            report,
            [RelEvent::new(Rel::DIAL, 2).into(), Syn::REPORT.into()],
        );

        Ok(())
    }
}