Struct SocketCan 

pub struct SocketCan { /* private fields */ }

Classic CAN SocketCAN adapter implementing embedded-can-interface traits.

Implementations

impl SocketCan

pub fn open(iface: &str) -> Result<Self, SocketcanError>

Open a SocketCAN interface by name (e.g. "can0").

pub fn new(inner: CanSocket) -> Self

Wrap an existing socketcan::CanSocket.

pub fn as_inner(&self) -> &CanSocket

Borrow the inner SocketCAN socket.

pub fn as_inner_mut(&mut self) -> &mut CanSocket

Mutably borrow the inner SocketCAN socket.

pub fn into_inner(self) -> CanSocket

Unwrap into the inner SocketCAN socket.

Trait Implementations

impl AsRawFd for SocketCan

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl BlockingControl for SocketCan

type Error = Error

Error returned by the driver implementation.

fn set_nonblocking(&mut self, on: bool) -> Result<(), Self::Error>

Globally toggle nonblocking mode.

impl Debug for SocketCan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FilterConfig for SocketCan

type Error = Error

Error returned by the driver implementation.

type FiltersHandle<'a> = () where Self: 'a

Handle used for modifying filters in-place (e.g. a bank accessor).

fn set_filters(&mut self, filters: &[IdMaskFilter]) -> Result<(), Self::Error>

Replace the current filter configuration with a list of ID/mask pairs.

fn modify_filters(&mut self) -> Self::FiltersHandle<'_>

Access filter banks through a handle (optional ergonomic API).

impl RxFrameIo for SocketCan

type Frame = CanFrame

The CAN frame type.

type Error = Error

Error returned by the driver implementation.

fn recv(&mut self) -> Result<Self::Frame, Self::Error>

Receive a frame, blocking until one is available.

fn try_recv(&mut self) -> Result<Self::Frame, Self::Error>

Attempt to receive a frame without blocking.

fn recv_timeout( &mut self, timeout: Duration, ) -> Result<Self::Frame, Self::Error>

Receive a frame, waiting up to timeout.

fn wait_not_empty(&mut self) -> Result<(), Self::Error>

Wait until the receive queue is non-empty.

impl TxFrameIo for SocketCan

type Frame = CanFrame

The CAN frame type.

type Error = Error

Error returned by the driver implementation.

fn send(&mut self, frame: &Self::Frame) -> Result<(), Self::Error>

Send a frame, blocking until it is accepted by the driver.

fn try_send(&mut self, frame: &Self::Frame) -> Result<(), Self::Error>

Attempt to send a frame without blocking.

fn send_timeout( &mut self, frame: &Self::Frame, timeout: Duration, ) -> Result<(), Self::Error>

Send a frame, waiting up to timeout for the driver to accept it.