socketcan-alt 0.1.0

Rust binding for SocketCAN
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

mod data;
mod error;
mod fd_data;
mod id;
mod remote;

use crate::sys;
pub use data::DataFrame;
pub use error::ErrorFrame;
pub use fd_data::FdDataFrame;
pub use id::Id;
pub use remote::RemoteFrame;
use std::mem::size_of_val;
use std::os::raw::c_void;

#[derive(Clone, Copy, Debug)]
#[cfg_attr(test, derive(PartialEq))]
pub enum Frame {
    Data(DataFrame),
    FdData(FdDataFrame),
    Remote(RemoteFrame),
    Error(ErrorFrame),
}

impl Frame {
    pub(crate) fn from_can_frame(inner: sys::can_frame) -> Self {
        if inner.can_id & sys::CAN_RTR_FLAG != 0 {
            Self::Remote(RemoteFrame(inner))
        } else if inner.can_id & sys::CAN_ERR_FLAG != 0 {
            Self::Error(ErrorFrame(inner))
        } else {
            Self::Data(DataFrame(inner))
        }
    }

    pub(crate) fn from_canfd_frame(inner: sys::canfd_frame) -> Self {
        assert_eq!(inner.can_id & (sys::CAN_RTR_FLAG | sys::CAN_ERR_FLAG), 0);
        Self::FdData(FdDataFrame(inner))
    }

    pub(crate) fn as_ptr(&self) -> *const c_void {
        match self {
            Self::Data(DataFrame(inner))
            | Self::Remote(RemoteFrame(inner))
            | Self::Error(ErrorFrame(inner)) => inner as *const _ as _,
            Self::FdData(FdDataFrame(inner)) => inner as *const _ as _,
        }
    }

    pub(crate) fn size(&self) -> usize {
        match self {
            Self::Data(DataFrame(inner))
            | Self::Remote(RemoteFrame(inner))
            | Self::Error(ErrorFrame(inner)) => size_of_val(inner),
            Self::FdData(FdDataFrame(inner)) => size_of_val(inner),
        }
    }
}

#[cfg(test)]
mod tests;