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
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use core::time::Duration;

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

/// Transmit classic CAN frames.
pub trait Transmit {
    type Error: CanError;

    /// Send a classic CAN frame.
    fn transmit(&mut self, frame: &CanFrame) -> Result<(), Self::Error>;
}

/// Receive classic CAN frames.
pub trait Receive {
    type Error: CanError;
    /// The timestamp type used by this backend (e.g., `std::time::Instant`).
    type Timestamp: Clone;

    /// Blocks until a classic CAN frame is available.
    fn receive(&mut self) -> Result<Timestamped<CanFrame, Self::Timestamp>, Self::Error>;

    /// Returns immediately with `Ok(None)` if no frame is available.
    fn try_receive(
        &mut self,
    ) -> Result<Option<Timestamped<CanFrame, Self::Timestamp>>, Self::Error>;

    /// Blocks until a frame is available or the timeout expires.
    /// Returns `Ok(None)` on timeout.
    fn receive_timeout(
        &mut self,
        timeout: Duration,
    ) -> Result<Option<Timestamped<CanFrame, Self::Timestamp>>, Self::Error>;
}

/// Transmit CAN FD frames.
pub trait TransmitFd {
    type Error: CanError;

    /// Send a CAN FD frame.
    fn transmit_fd(&mut self, frame: &CanFdFrame) -> Result<(), Self::Error>;
}

/// Receive any frame (classic or FD) from an FD-capable bus.
pub trait ReceiveFd {
    type Error: CanError;
    /// The timestamp type used by this backend (e.g., `std::time::Instant`).
    type Timestamp: Clone;

    /// Blocks until any frame is available; returns `Frame` enum.
    fn receive_fd(&mut self) -> Result<Timestamped<Frame, Self::Timestamp>, Self::Error>;

    /// Non-blocking variant.
    fn try_receive_fd(
        &mut self,
    ) -> Result<Option<Timestamped<Frame, Self::Timestamp>>, Self::Error>;

    /// Blocks until a frame is available or the timeout expires.
    /// Returns `Ok(None)` on timeout.
    fn receive_fd_timeout(
        &mut self,
        timeout: Duration,
    ) -> Result<Option<Timestamped<Frame, Self::Timestamp>>, Self::Error>;
}