drmem-api 0.5.0

Traits and types used internally by the DrMem control system
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

use crate::device;
use std::future::Future;
use std::marker::PhantomData;
use std::pin::Pin;

/// A function that drivers use to report updated values of a device.
pub type ReportReading = Box<
    dyn Fn(device::Value) -> Pin<Box<dyn Future<Output = ()> + Send>>
        + Send
        + Sync,
>;

/// Represents a read-only device that uses a specified type for its
/// reading. Any type that can be converted to a `device::Value` is
/// acceptable.
pub struct ReadOnlyDevice<T: Into<device::Value> + Clone> {
    report_chan: ReportReading,
    phantom: PhantomData<T>,
}

impl<T> ReadOnlyDevice<T>
where
    T: Into<device::Value> + Clone,
{
    /// Returns a new `ReadOnlyDevice` type.
    pub fn new(report_chan: ReportReading) -> Self {
        ReadOnlyDevice {
            report_chan,
            phantom: PhantomData,
        }
    }

    /// Saves a new value, returned by the device, to the backend
    /// storage.
    pub fn report_update(
        &mut self,
        value: T,
    ) -> impl Future<Output = ()> + use<'_, T> {
        (self.report_chan)(value.into())
    }
}