Struct Signals 

pub struct Signals { /* private fields */ }

The eight data bytes of a J1939 frame.

Examples

use pamoja_can::Signals;

// Engine speed sits in bytes 4 and 5 of EEC1, at 0.125 rpm per bit.
let mut payload = Signals::new();
payload.set_u16(3, (1000.0 / 0.125) as u16);

assert_eq!(payload.u16(3), Some(8000));
assert_eq!(payload.u8(0), Some(pamoja_can::NOT_AVAILABLE));

Implementations

impl Signals

pub fn new() -> Signals

Builds a payload with every signal marked not available.

Returns

Eight bytes of NOT_AVAILABLE, ready for a sender to write only what it has.

pub fn from_bytes(bytes: [u8; 8]) -> Signals

Reads a payload received off the bus.

Arguments

• bytes - the eight data bytes of a received frame.

Returns

The payload, ready for its signals to be read out.

pub fn as_bytes(&self) -> &[u8; 8]

Returns the eight data bytes, ready to put in a frame.

Returns

The payload in wire order.

pub fn set_u8(&mut self, at: usize, value: u8) -> &mut Signals

Writes a one-byte signal.

Arguments

• at - the byte offset the parameter group places the signal at, 0..=7.
• value - the raw value, already scaled as the group defines.

Returns

The payload, so writes chain.

pub fn set_u16(&mut self, at: usize, value: u16) -> &mut Signals

Writes a two-byte little-endian signal.

Arguments

• at - the offset of the signal’s first byte, 0..=6.
• value - the raw value, already scaled as the group defines.

Returns

The payload, so writes chain.

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

Reads a one-byte signal.

Arguments

• at - the byte offset the parameter group places the signal at.

Returns

The raw value, or None if at is past the payload.

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

Reads a two-byte little-endian signal.

Arguments

• at - the offset of the signal’s first byte.

Returns

The raw value, or None if the signal would run past the payload.

Trait Implementations

impl Clone for Signals

fn clone(&self) -> Signals

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Signals

impl Debug for Signals

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

Formats the value using the given formatter.

impl Default for Signals

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Signals

impl PartialEq for Signals

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