Struct MessageList 

pub struct MessageList { /* private fields */ }

Encapsulates the messages array and count for a DBC

Uses Vec<Message> for dynamic sizing.

Implementations

impl MessageList

pub fn iter(&self) -> impl Iterator<Item = &Message> + '_

Get an iterator over the messages

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM")?;
let mut iter = dbc.messages().iter();
let message = iter.next().unwrap();
assert_eq!(message.name(), "Engine");
assert_eq!(message.id(), 256);
assert!(iter.next().is_none());

pub fn len(&self) -> usize

Get the number of messages

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM")?;
assert_eq!(dbc.messages().len(), 1);

pub fn is_empty(&self) -> bool

Returns true if there are no messages

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM")?;
assert!(dbc.messages().is_empty());

pub fn at(&self, index: usize) -> Option<&Message>

Get a message by index, or None if index is out of bounds

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM")?;
if let Some(message) = dbc.messages().at(0) {
    assert_eq!(message.name(), "Engine");
}

pub fn find(&self, name: &str) -> Option<&Message>

Find a message by name, or None if not found

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM")?;
if let Some(message) = dbc.messages().find("Engine") {
    assert_eq!(message.name(), "Engine");
    assert_eq!(message.id(), 256);
}

pub fn find_by_id(&self, id: u32) -> Option<&Message>

Find a message by CAN ID, or None if not found

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM")?;
if let Some(message) = dbc.messages().find_by_id(256) {
    assert_eq!(message.name(), "Engine");
    assert_eq!(message.id(), 256);
}

Trait Implementations

impl Clone for MessageList

fn clone(&self) -> MessageList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageList

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

Formats the value using the given formatter.

impl Hash for MessageList

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MessageList

fn eq(&self, other: &MessageList) -> 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 Eq for MessageList

impl StructuralPartialEq for MessageList