can_hal_socketcan/
lib.rs

1//! # can-hal-socketcan
2//!
3//! Linux SocketCAN backend for [`can_hal`] traits.
4//!
5//! This crate provides [`SocketCanDriver`] and [`SocketCanChannel`] which
6//! implement the hardware-agnostic CAN traits defined in `can-hal`, enabling
7//! portable CAN application code to run on Linux systems with SocketCAN
8//! interfaces.
9//!
10//! # Example
11//!
12//! ```rust,no_run
13//! use can_hal::{CanId, CanFrame, Transmit, Receive};
14//! use can_hal_socketcan::SocketCanDriver;
15//!
16//! let driver = SocketCanDriver::new();
17//! let mut channel = driver
18//!     .channel_by_name("vcan0")
19//!     .connect()
20//!     .unwrap();
21//!
22//! let id = CanId::new_standard(0x123).unwrap();
23//! let frame = CanFrame::new(id, &[0xDE, 0xAD]).unwrap();
24//! channel.transmit(&frame).unwrap();
25//! ```
26//!
27//! # Bitrate Configuration
28//!
29//! SocketCAN bitrate is configured at the OS level, not through the socket
30//! API - the builder deliberately has no timing methods. Use `ip link set`
31//! or netlink before opening a channel:
32//!
33//! ```bash
34//! sudo ip link set can0 type can bitrate 500000
35//! sudo ip link set can0 up
36//! ```
37
38pub mod channel;
39pub mod driver;
40pub mod error;
41
42mod convert;
43
44pub use channel::SocketCanChannel;
45pub use driver::{SocketCanChannelBuilder, SocketCanDriver};
46pub use error::SocketCanError;
47
48// Compile-time assertion: channel must be Send so it can be moved across threads.
49const _: fn() = || {
50    const fn assert_send<T: Send>() {}
51    assert_send::<SocketCanChannel>();
52};
can_hal_socketcan/lib.rs

can_hal_socketcan/
lib.rs
