Struct CanFdSocket 

pub struct CanFdSocket(/* private fields */);

A socket for CAN FD devices.

This can transmit and receive CAN 2.0 frames with up to 8-bytes of data, or CAN Flexible Data (FD) frames with up to 64-bytes of data.

Implementations

impl CanFdSocket

pub fn read_raw_frame(&self) -> IoResult<CanRawFrame>

Reads a raw CAN frame from the socket.

This might be either type of CAN frame, a classic CAN 2.0 frame or an FD frame.

Trait Implementations

impl AsFd for CanFdSocket

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for CanFdSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Can for CanFdSocket

fn receive(&mut self) -> Result<Self::Frame>

Blocking call to receive the next frame from the bus.

This block and wait for the next frame to be received from the bus. If an error frame is received, it will be converted to a CanError and returned as an error.

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

Blocking transmit of a frame to the bus.

type Frame = CanAnyFrame

Associated frame type.

type Error = Error

Associated error type.

impl Can for CanFdSocket

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

Non-blocking call to receive the next frame from the bus.

If an error frame is received, it will be converted to a CanError and returned as an error. If no frame is available, it returns a WouldBlck error.

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

Non-blocking transmit of a frame to the bus.

type Frame = CanAnyFrame

Associated frame type.

type Error = Error

Associated error type.

impl Debug for CanFdSocket

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

Formats the value using the given formatter.

impl From<OwnedFd> for CanFdSocket

fn from(fd: OwnedFd) -> CanFdSocket

Converts to this type from the input type.

impl IntoRawFd for CanFdSocket

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for CanFdSocket

fn read(&mut self, buf: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Socket for CanFdSocket

type FrameType = CanAnyFrame

CanFdSocket can read/write classic CAN 2.0 or FD frames.

fn open_addr(addr: &CanAddr) -> IoResult<Self>

Opens the FD socket by interface index.

fn as_raw_socket(&self) -> &Socket

Gets a shared reference to the underlying socket object

fn as_raw_socket_mut(&mut self) -> &mut Socket

Gets a mutable reference to the underlying socket object

fn write_frame<F>(&self, frame: &F) -> IoResult<()>

where F: Into<Self::FrameType> + AsPtr,

Writes any type of CAN frame to the socket.

fn read_frame(&self) -> IoResult<CanAnyFrame>

Reads either type of CAN frame from the socket.

fn open(ifname: &str) -> IoResult<Self>

where Self: Sized,

Open a named CAN device.

fn open_iface(ifindex: u32) -> IoResult<Self>

where Self: Sized,

Open CAN device by interface number.

fn nonblocking(&self) -> IoResult<bool>

Determines if the socket is currently in nonblocking mode.

fn set_nonblocking(&self, nonblocking: bool) -> IoResult<()>

Change socket to non-blocking mode or back to blocking mode.

fn read_timeout(&self) -> IoResult<Option<Duration>>

Gets the read timeout on the socket, if any.

fn set_read_timeout<D>(&self, duration: D) -> IoResult<()>

where D: Into<Option<Duration>>,

Sets the read timeout on the socket

fn write_timeout(&self) -> IoResult<Option<Duration>>

Gets the write timeout on the socket, if any.

fn set_write_timeout<D>(&self, duration: D) -> IoResult<()>

where D: Into<Option<Duration>>,

Sets the write timeout on the socket

fn read_frame_timeout(&self, timeout: Duration) -> IoResult<Self::FrameType>

Blocking read a single can frame with timeout.

fn write_frame_insist<F>(&self, frame: &F) -> IoResult<()>

where F: Into<Self::FrameType> + AsPtr,

Blocking write a single can frame, retrying until it gets sent successfully.

impl SocketOptions for CanFdSocket

fn set_socket_option<T>( &self, level: c_int, name: c_int, val: &T, ) -> IoResult<()>

Sets an option on the socket.

fn set_socket_option_mult<T>( &self, level: c_int, name: c_int, values: &[T], ) -> IoResult<()>

Sets a collection of multiple socke options with one call.

fn set_filters<F>(&self, filters: &[F]) -> IoResult<()>

where F: Into<CanFilter> + Copy,

Sets CAN ID filters on the socket.

fn set_filter_drop_all(&self) -> IoResult<()>

Disable reception of CAN frames.

fn set_filter_accept_all(&self) -> IoResult<()>

Accept all frames, disabling any kind of filtering.

fn set_error_filter(&self, mask: u32) -> IoResult<()>

Sets the error mask on the socket.

fn set_error_filter_drop_all(&self) -> IoResult<()>

Sets the error mask on the socket to reject all errors.

fn set_error_filter_accept_all(&self) -> IoResult<()>

Sets the error mask on the socket to accept all errors.

fn set_error_mask(&self, mask: u32) -> IoResult<()>

Sets the error mask on the socket.

fn set_loopback(&self, enabled: bool) -> IoResult<()>

Enable or disable loopback.

fn set_recv_own_msgs(&self, enabled: bool) -> IoResult<()>

Enable or disable receiving of own frames.

fn set_join_filters(&self, enabled: bool) -> IoResult<()>

Enable or disable join filters.

impl TryFrom<CanSocket> for CanFdSocket

type Error = Error

The type returned in the event of a conversion error.

fn try_from(sock: CanSocket) -> Result<Self, Self::Error>

Performs the conversion.

impl Write for CanFdSocket

fn write(&mut self, buf: &[u8]) -> IoResult<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> IoResult<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.