Skip to main content

IdFilter

Struct IdFilter 

Source
pub struct IdFilter { /* private fields */ }
Expand description

ID filter for single ID or mask-based matching

Supports both exact ID matching and mask-based matching.

§Example

use canlink_hal::filter::IdFilter;

// Exact match for ID 0x123
let filter = IdFilter::new(0x123);

// Mask match: matches 0x120-0x12F
let filter = IdFilter::with_mask(0x120, 0x7F0);

Implementations§

Source§

impl IdFilter

Source

pub fn new(id: u32) -> Self

Create a new filter for exact ID match (standard frame)

§Arguments
  • id - The CAN ID to match (must be <= 0x7FF)
§Panics

Panics if id exceeds the maximum standard ID.

Source

pub fn with_mask(id: u32, mask: u32) -> Self

Create a new filter with mask (standard frame)

§Arguments
  • id - The target ID
  • mask - Bits set to 1 must match, bits set to 0 are ignored
§Example
use canlink_hal::filter::IdFilter;

// Match IDs 0x120-0x12F (mask ignores lower 4 bits)
let filter = IdFilter::with_mask(0x120, 0x7F0);
Source

pub fn new_extended(id: u32) -> Self

Create a new filter for extended frame

§Arguments
  • id - The CAN ID to match (must be <= 0x1FFFFFFF)
§Panics

Panics if id exceeds the maximum extended ID.

Source

pub fn with_mask_extended(id: u32, mask: u32) -> Self

Create a new filter with mask for extended frame

Source

pub fn try_new(id: u32) -> Result<Self, FilterError>

Try to create a new filter, returning error if ID is invalid

§Errors

Returns FilterError::IdOutOfRange if id exceeds the maximum standard ID.

Source

pub fn try_new_extended(id: u32) -> Result<Self, FilterError>

Try to create a new extended filter, returning error if ID is invalid

§Errors

Returns FilterError::IdOutOfRange if id exceeds the maximum extended ID.

Source

pub fn set_hardware(&mut self, hardware: bool)

Set whether this filter can use hardware acceleration

Source

pub fn id(&self) -> u32

Get the target ID

Source

pub fn mask(&self) -> u32

Get the mask

Source

pub fn is_extended(&self) -> bool

Check if this filter is for extended frames

Trait Implementations§

Source§

impl Clone for IdFilter

Source§

fn clone(&self) -> IdFilter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IdFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl MessageFilter for IdFilter

Source§

fn matches(&self, message: &CanMessage) -> bool

Check if a message matches this filter Read more
Source§

fn priority(&self) -> u32

Get the filter priority Read more
Source§

fn is_hardware(&self) -> bool

Check if this is a hardware filter Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.