Struct esb::payload::EsbHeader

pub struct EsbHeader { /* fields omitted */ }

The non-payload portion of an ESB packet

This is typically used to create a Packet Grant using methods from the EsbApp or EsbIrq interfaces.

Example

use esb::EsbHeader;

let builder_result = EsbHeader::build()
    .max_payload(252)
    .pid(0)
    .pipe(1)
    .no_ack(true)
    .check();

let new_result = EsbHeader::new(
    252,
    0,
    1,
    true,
);

assert_eq!(builder_result, new_result);

Implementations

impl EsbHeader

pub fn build() -> EsbHeaderBuilder

Create a new packet header using a builder pattern

See the docs for EsbBuilder for more information.

pub fn new(
    max_payload_length: u8,
    pid: u8,
    pipe: u8,
    no_ack: bool
) -> Result<Self, Error>

Create a new packet header

Notes on valid values:

• max_payload_length must be between 0 and 252 bytes, inclusive.
• pid must be between 0 and 3, inclusive.
• pipe must be between 0 and 7, inclusive.

pub fn pid(self) -> u8

Accessor for the Pipe ID of the packet

pub fn no_ack(self) -> bool

Accessor for the no-ack field of the packet

pub fn payload_len(self) -> usize

Accessor for the length (in bytes) of the payload

pub fn rssi(self) -> u8

Accessor for the rssi of the payload

Trait Implementations

impl Clone for EsbHeader

fn clone(&self) -> EsbHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EsbHeader

impl Debug for EsbHeader

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

Formats the value using the given formatter.

impl Eq for EsbHeader

impl PartialEq<EsbHeader> for EsbHeader

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for EsbHeader

impl StructuralPartialEq for EsbHeader