Struct esb::payload::EsbHeaderBuilder

pub struct EsbHeaderBuilder(_);

A builder for an EsbHeader structure

The builder is converted into an EsbHeader by calling the check() method.

Example

use esb::EsbHeaderBuilder;

let header_result = EsbHeaderBuilder::default()
    .max_payload(252)
    .pid(0)
    .pipe(0)
    .no_ack(true)
    .check();

assert!(header_result.is_ok());

Default Header Contents

By default, the following settings will be used:

Field	Default Value
pid	0
no_ack	true
length	0
pipe	0

Implementations

impl EsbHeaderBuilder

pub fn pipe(self, pipe: u8) -> Self

Set the pipe. Must be in the range 0..=7.

pub fn max_payload(self, max_payload: u8) -> Self

Set the max payload. Must be in the range 0..=252.

pub fn no_ack(self, no_ack: bool) -> Self

Enable/disable acknowledgment

pub fn pid(self, pid: u8) -> Self

Set the pid. Must be in the range 0..=3.

pub fn check(self) -> Result<EsbHeader, Error>

Finalize the header.

If the set parameters are out of range, an error will be returned.

Trait Implementations

impl Clone for EsbHeaderBuilder

fn clone(&self) -> EsbHeaderBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EsbHeaderBuilder

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

Formats the value using the given formatter.

impl Default for EsbHeaderBuilder

fn default() -> Self

Returns the "default value" for a type.

impl Eq for EsbHeaderBuilder

impl PartialEq<EsbHeaderBuilder> for EsbHeaderBuilder

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

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

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

This method tests for !=.

impl StructuralEq for EsbHeaderBuilder

impl StructuralPartialEq for EsbHeaderBuilder