Struct CanFilter

pub struct CanFilter { /* private fields */ }

A CAN filter.

Can be used to have the kernel filter incoming frames before they are delivered to userspace, to avoid unnecessarily waking up just to ignore a frame.

Implementations

impl CanFilter

pub const fn new(id: CanId) -> Self

Create a new pass-all CAN filter with a standard or extended ID.

The mask is still set to zero when the filter is created. You have to call additional methods to restrict what frames match filter.

pub const fn new_standard(id: StandardId) -> Self

Create a new pass-all CAN filter with a standard ID.

The mask is still set to zero when the filter is created. You have to call additional methods to restrict what frames match filter.

pub const fn new_extended(id: ExtendedId) -> Self

Create a new pass-all CAN filter with an extended ID.

The mask is still set to zero when the filter is created. You have to call additional methods to restrict what frames match filter.

pub const fn match_id_value(self) -> Self

Restrict the filter to match only frames with the same numerical ID.

The filter will still accept extended and standard frames (if the numerical value is possible for standard frames).

Adds to any restrictions already applied to the filter.

pub const fn match_id_mask(self, mask: u32) -> Self

Restrict the filter to match only frames where frame.id & mask == filter.id & mask.

Only the lower 29 bits of the mask are used.

pub const fn match_frame_format(self) -> Self

Restrict the filter to match only extended IDs or standard IDs (depending on the ID the filter was constructed with).

Adds to any restrictions already applied to the filter.

pub const fn match_exact_id(self) -> Self

Restrict the filter to match only on exact ID matches.

This means the ID must match exactly, including the fact if it was an extended or standard ID.

This is equivalent to:

filter.match_id_value().match_frame_format()

Adds to any restrictions already applied to the filter.

pub const fn match_rtr_only(self) -> Self

Restrict the filter to match only RTR frames.

pub const fn match_data_only(self) -> Self

Restrict the filter to match only data frames.

Overrides any previous calls to Self::match_rtr_only().

pub const fn inverted(self, inverted: bool) -> Self

Make the filter inverted or non-inverted.

When inverted, only frame that normally would not match the filter will match the filter.

pub const fn is_inverted(self) -> bool

Check if the filter is inverted.

When inverted, only frame that normally would not match the filter will match the filter.

pub const fn test(&self, frame: &CanFrame) -> bool

Test if a frame matches the filter.

Trait Implementations

impl Clone for CanFilter

fn clone(&self) -> CanFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanFilter

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

Formats the value using the given formatter.

impl Copy for CanFilter