Enum CanId

#[repr(C)]
pub enum CanId {
    Standard(StandardId),
    Extended(ExtendedId),
}

A CAN ID, either standard (11 bit) or extended (29 bits).

Variants

Standard(StandardId)

A standard 11 bit CAN ID.

Extended(ExtendedId)

An extended 29 bit CAN ID.

Implementations

impl CanId

pub const fn new(id: u32) -> Result<Self, InvalidId>

Create a new CAN ID from a raw value.

If the value fits in a 11 bit standard CAN ID, this function will return Self::Standard. a standard ID will be created.

Otherwise, if the value fits in a 29 bits extended CAN ID, this function returns Self::Extended.

If the value doesn’t fit in either, this function returns an error.

pub const fn new_standard(id: u16) -> Result<Self, InvalidId>

Create a new standard CAN ID from a raw value.

If the value doesn’t fit in a standard 11 bit CAN ID, this function returns an error.

pub const fn new_extended(id: u32) -> Result<Self, InvalidId>

Create a new extended CAN ID from a raw value.

If the value doesn’t fit in an extended 29 bit CAN ID, this function returns an error.

pub const fn as_u32(self) -> u32

Get the raw value as a u32.

pub const fn as_standard(self) -> Option<StandardId>

Get self as a StandardId, or None if this is an extended ID.

Note: This function always returns None if self is an extended ID. It doesn’t matter if the value would have fit in a StandardId.

Use Self::to_standard() if you want to try to convert extended IDs to standard IDs.

pub const fn as_extended(self) -> Option<ExtendedId>

Get self as an ExtendedId, or None if this is a standard ID.

Use Self::to_extended() if you want to convert standard IDs to extended IDs.

pub const fn to_standard(self) -> Result<StandardId, InvalidId>

Try to convert the ID to a standard ID.

Returns an error if the value doesn’t fit in a standard ID.

pub const fn to_extended(self) -> ExtendedId

Convert the ID to an extended ID.

Trait Implementations

impl Clone for CanId

fn clone(&self) -> CanId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanId

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

Formats the value using the given formatter.

impl From<CanId> for ExtendedId

fn from(value: CanId) -> Self

Converts to this type from the input type.

impl From<ExtendedId> for CanId

fn from(value: ExtendedId) -> Self

Converts to this type from the input type.

impl From<StandardId> for CanId

fn from(value: StandardId) -> Self

Converts to this type from the input type.

impl From<u16> for CanId

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u8> for CanId

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromStr for CanId

type Err = ParseIdError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl LowerHex for CanId

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

Formats the value using the given formatter.

impl Ord for CanId

fn cmp(&self, other: &CanId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<CanId> for ExtendedId

fn eq(&self, other: &CanId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<CanId> for StandardId

fn eq(&self, other: &CanId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ExtendedId> for CanId

fn eq(&self, other: &ExtendedId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<StandardId> for CanId

fn eq(&self, other: &StandardId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for CanId

fn eq(&self, other: &CanId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CanId

fn partial_cmp(&self, other: &CanId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<CanId> for StandardId

type Error = InvalidId

The type returned in the event of a conversion error.

fn try_from(value: CanId) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for CanId

type Error = InvalidId

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for CanId

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

Formats the value using the given formatter.

impl Copy for CanId

impl Eq for CanId

impl StructuralPartialEq for CanId