Struct FrameBuilder

pub struct FrameBuilder<'p, T> { /* private fields */ }

A helper for building IEEE 802.15.4 frames.

Implementations

impl<'p> FrameBuilder<'p, Ack>

pub fn new_imm_ack(sequence_number: u8) -> Self

Create a new builder for an immediate acknowledgment frame.

pub fn new_ack() -> Self

Create a new builder for an acknowledgment frame.

impl<'p> FrameBuilder<'p, Beacon>

pub fn new_beacon() -> Self

Create a new builder for a beacon frame.

impl<'p> FrameBuilder<'p, EnhancedBeacon>

pub fn new_enhanced_beacon() -> Self

Create a new builder for an enhanced beacon frame.

impl<'p> FrameBuilder<'p, Data>

pub fn new_data(payload: &'p [u8]) -> Self

Create a new builder for a data frame.

impl<'p, T> FrameBuilder<'p, T>

pub fn set_sequence_number(self, sequence_number: u8) -> Self

Set the frame sequence number.

Note

This method disables sequence number suppression.

pub fn set_dst_pan_id(self, pan_id: u16) -> Self

Set the destination PAN ID.

pub fn set_src_pan_id(self, pan_id: u16) -> Self

Set the source PAN ID.

pub fn set_dst_address(self, address: Address) -> Self

Set the destination address.

Note

Based on the address, the addressing mode will be set.

pub fn set_src_address(self, address: Address) -> Self

Set the source address.

Note

Based on the address, the addressing mode will be set.

pub fn add_header_information_element( self, ie: HeaderInformationElementRepr, ) -> Self

Add a header Information Element.

Note

This method will enable the Information Elements Present bit in the frame control. The frame version will be set to IEEE 802.15.4-2020.

pub fn add_payload_information_element( self, ie: PayloadInformationElementRepr, ) -> Self

Add a payload Information Element.

Note

This method will enable the Information Elements Present bit in the frame control. The frame version will be set to IEEE 802.15.4-2020.

pub fn set_payload(self, payload: &'p [u8]) -> Self

Set the frame payload.

pub fn finalize(self) -> Result<FrameRepr<'p>>

Finalize the frame builder, returning the frame representation.

Note

This method will check and set if PAN ID compression is possible, depending on the frame version.