Struct Header 

pub struct Header {
    pub id: u8,
    pub size: u16,
    pub order: u8,
}

The header on every message, either way.

Fields

id: u8

An identifier the host picks. The bridge does not check it and the reference does not compare it on the way back, so it is a courtesy rather than a guard.

size: u16

How many bytes of payload follow.

order: u8

What the message is, or, from the bridge, what it answers.

Implementations

impl Header

pub const fn to_bytes(self) -> [u8; 4]

The bytes that go out.

Returns

The identifier, the size high byte first, then the order.

Examples

use pamoja_radios::sx1302::bridge::{Header, ORDER_WRITE_GPIO};

let header = Header { id: 7, size: 3, order: ORDER_WRITE_GPIO };
assert_eq!(header.to_bytes(), [7, 0, 3, 0x04]);

pub const fn from_bytes(bytes: [u8; 4]) -> Header

Reads a header the bridge sent.

Arguments

• bytes - the four bytes.

Returns

The header.

pub const fn is_answer(&self) -> bool

Whether this header answers an order, rather than carrying one.

Returns

Whether the order is in the range the bridge answers with.

pub const fn answers(&self, order: u8) -> bool

Whether this header answers a particular order.

Arguments

• order - the order that was sent.

Returns

Whether the bridge answered that one.

Examples

use pamoja_radios::sx1302::bridge::{Header, ACK, ORDER_PING};

let answer = Header::from_bytes([7, 0, 21, ORDER_PING + ACK]);
assert!(answer.answers(ORDER_PING));
assert!(!answer.answers(ORDER_PING + 1));

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl PartialEq for Header

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Header