Enum socketcan::errors::CanError

pub enum CanError {
    TransmitTimeout,
    LostArbitration(u8),
    ControllerProblem(ControllerProblem),
    ProtocolViolation {
        vtype: ViolationType,
        location: Location,
    },
    TransceiverError,
    NoAck,
    BusOff,
    BusError,
    Restarted,
    DecodingFailure(CanErrorDecodingFailure),
    Unknown(u32),
}

A CAN bus error derived from an error frame.

An CAN interface device driver can send detailed error information up to the application in an “error frame”. These are selectable by the application by applying an error bitmask to the socket to choose which types of errors to receive.

The error frame can then be converted into this CanError which is a proper Rust error type which implements std::error::Error.

Most error types here corresponds to a bit in the error mask of a CAN ID word of an error frame - a frame in which the CAN error flag (CAN_ERR_FLAG) is set. But there are additional types to handle any problems decoding the error frame.

Variants

TransmitTimeout

TX timeout (by netdevice driver)

LostArbitration(u8)

Arbitration was lost. Contains the bit number after which arbitration was lost or 0 if unspecified.

ControllerProblem(ControllerProblem)

Controller problem

ProtocolViolation

Fields

vtype: ViolationType

The type of protocol violation

location: Location

The location (field or bit) of the violation

Protocol violation at the specified Location.

TransceiverError

Transceiver Error.

NoAck

No ACK received for current CAN frame.

BusOff

Bus off (due to too many detected errors)

BusError

Bus error (due to too many detected errors)

Restarted

The bus has been restarted

DecodingFailure(CanErrorDecodingFailure)

There was an error decoding the error frame

Unknown(u32)

Unknown, possibly invalid, error

Trait Implementations

impl Clone for CanError

fn clone(&self) -> CanError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanError

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

Formats the value using the given formatter.

impl Display for CanError

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

Formats the value using the given formatter.

impl Error for CanError

fn kind(&self) -> ErrorKind

Convert error to a generic CAN error kind

impl Error for CanError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl From<CanError> for CanErrorFrame

fn from(err: CanError) -> Self

Converts to this type from the input type.

impl From<CanError> for Error

fn from(source: CanError) -> Self

Converts to this type from the input type.

impl From<CanErrorFrame> for CanError

fn from(frame: CanErrorFrame) -> Self

Constructs a CAN error from an error frame.

impl Copy for CanError