Struct Filter 

pub struct Filter { /* private fields */ }

A frame a node keeps: one whose identifier, masked, equals the filter’s, and whose width, standard or extended, is the filter’s.

This is the SocketCAN filter, received_id & mask == id & mask, with the frame format always part of the match, so a filter for an extended identifier never passes a standard frame that happens to share its low bits.

Examples

use pamoja_can::bus::Filter;
use pamoja_can::{CanId, J1939Id};

// Engine speed, parameter group 61444, from any engine controller at any priority.
let engine_speed = Filter::pgn(61_444);
assert!(engine_speed.matches(J1939Id::broadcast(3, 61_444, 0x00).to_id()));
assert!(engine_speed.matches(J1939Id::broadcast(6, 61_444, 0x01).to_id()));
assert!(!engine_speed.matches(J1939Id::broadcast(3, 61_443, 0x00).to_id()));

// One standard identifier and nothing else.
let motor = Filter::exact(CanId::standard(0x20A));
assert!(motor.matches(CanId::standard(0x20A)));
assert!(!motor.matches(CanId::extended(0x20A)));

Implementations

impl Filter

pub fn new(id: CanId, mask: u32) -> Filter

A filter on the identifier bits a mask selects.

Arguments

• id - the identifier to match, which also fixes the frame format.
• mask - the identifier bits that have to match; bits outside the identifier’s width are dropped.

Returns

The filter.

pub fn exact(id: CanId) -> Filter

A filter that passes one identifier and nothing else.

Arguments

• id - the identifier.

Returns

The filter.

pub fn pgn(pgn: u32) -> Filter

A filter that passes one J1939 parameter group at any priority, from any source, and for an addressed group, to any destination.

Arguments

• pgn - the parameter group number.

Returns

The filter.

pub fn id(&self) -> CanId

Returns the identifier the filter matches.

pub fn mask(&self) -> u32

Returns the identifier bits that have to match.

pub fn matches(&self, id: CanId) -> bool

Reports whether a frame with an identifier passes the filter.

Arguments

• id - the frame’s identifier.

Returns

true when the frame formats agree and the masked bits are equal.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Filter

impl Debug for Filter

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

Formats the value using the given formatter.

impl Eq for Filter

impl PartialEq for Filter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Filter