Struct ieee802154::mac::beacon::SuperframeSpecification

pub struct SuperframeSpecification {
    pub beacon_order: BeaconOrder,
    pub superframe_order: SuperframeOrder,
    pub final_cap_slot: u8,
    pub battery_life_extension: bool,
    pub pan_coordinator: bool,
    pub association_permit: bool,
}

Superframe specification

The superframe specification describes the organisation of frames in the air when using superframes and/or periodical beacons.

Fields

beacon_order: BeaconOrder

Beacon order, 0-15, where 15 is on demand.

Beacon interval = BaseSuperframeDuration × (2 ^ BeaconOrder)

superframe_order: SuperframeOrder

Superframe order, amount of time during wich this superframe is active

final_cap_slot: u8

final contention access period slot used

battery_life_extension: bool

Limit receiving of beacons for a period. Not used if beacon_order is OnDemand.

pan_coordinator: bool

Frame sent by a coordinator

association_permit: bool

The coordinator acceppts associations to the PAN

Implementations

impl SuperframeSpecification

pub fn decode(buf: &mut dyn Buf) -> Result<Self, DecodeError>

Decode superframe specification from byte buffer

Returns

Returns SuperframeSpecification and the number of bytes used are returned

Errors

This function returns an error, if the bytes either don't are enough or dont't contain valid data. Please refer to DecodeError for details.

pub fn encode(&self, buf: &mut dyn BufMut)

Encode superframe specification into a byte buffer

Trait Implementations

impl Clone for SuperframeSpecification

fn clone(&self) -> SuperframeSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SuperframeSpecification

impl Debug for SuperframeSpecification

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

Formats the value using the given formatter.

impl Eq for SuperframeSpecification

impl Hash for SuperframeSpecification

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<SuperframeSpecification> for SuperframeSpecification

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

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

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

This method tests for !=.

impl StructuralEq for SuperframeSpecification

impl StructuralPartialEq for SuperframeSpecification