can-hal-rs 0.4.1

Hardware-agnostic traits for CAN bus communication
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

use core::future::Future;

use crate::error::CanError;
use crate::frame::{CanFdFrame, CanFrame, Frame, Timestamped};

/// Async transmit of classic CAN frames.
pub trait AsyncTransmit {
    type Error: CanError;

    /// Asynchronously send a classic CAN frame.
    fn transmit(
        &mut self,
        frame: &CanFrame,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;
}

/// Async receive of classic CAN frames.
pub trait AsyncReceive {
    type Error: CanError;
    /// The timestamp type used by this backend.
    type Timestamp: Clone + Send;

    /// Asynchronously receive a classic CAN frame.
    fn receive(
        &mut self,
    ) -> impl Future<Output = Result<Timestamped<CanFrame, Self::Timestamp>, Self::Error>> + Send;
}

/// Async transmit of CAN FD frames.
pub trait AsyncTransmitFd {
    type Error: CanError;

    /// Asynchronously send a CAN FD frame.
    fn transmit_fd(
        &mut self,
        frame: &CanFdFrame,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;
}

/// Async receive of any frame (classic or FD).
pub trait AsyncReceiveFd {
    type Error: CanError;
    /// The timestamp type used by this backend.
    type Timestamp: Clone + Send;

    /// Asynchronously receive any frame.
    fn receive_fd(
        &mut self,
    ) -> impl Future<Output = Result<Timestamped<Frame, Self::Timestamp>, Self::Error>> + Send;
}