Struct ieee802154::mac::frame::header::Header

pub struct Header {
    pub frame_type: FrameType,
    pub frame_pending: bool,
    pub ack_request: bool,
    pub pan_id_compress: bool,
    pub seq_no_suppress: bool,
    pub ie_present: bool,
    pub version: FrameVersion,
    pub seq: u8,
    pub destination: Option<Address>,
    pub source: Option<Address>,
    pub auxiliary_security_header: Option<AuxiliarySecurityHeader>,
}

MAC frame header

External documentation for MAC frame format start at 5.2

Fields

frame_type: FrameType

Frame Type

frame_pending: bool

Frame Pending

The Frame Pending field shall be set to true if the device sending the frame has more data for the recipient,as described in 5.1.6.3. This field shall be set to false otherwise.

ack_request: bool

Acknowledgement Request

The AR field specifies whether an acknowledgment is required from the recipient device on receipt of a data or MAC command frame. If this field is set to true, the recipient device shall send an acknowledgment frame only if, upon reception, the frame passes the filtering described in 5.1.6.2. If this field is set to false, the recipient device shall not send an acknowledgment frame.

pan_id_compress: bool

PAN ID Compress

The PAN ID Compression field specifies whether the MAC frame is to be sent containing only one of the PAN identifier fields when both src and destination addresses are present. If this field is set to true and both the src and destination addresses are present, the frame shall contain only the Destination PAN Identifier field, and the Source PAN Identifier field shall be assumed equal to that of the destination. If this field is set to false, then the PAN Identifier field shall be present if and only if the corresponding address is present.

seq_no_suppress: bool

Suppress sequence number

ie_present: bool

Information element present

version: FrameVersion

Frame version

seq: u8

Sequence Number

destination: Option<Address>

Destination Address

source: Option<Address>

Source Address

auxiliary_security_header: Option<AuxiliarySecurityHeader>

Auxiliary security header. If security is enabled in this header, this field will be Some, else it will be None

Implementations

impl Header

pub fn get_octet_size(&self) -> usize

Get the size of this header in octets

pub fn has_security(&self) -> bool

Whether this header has security enabled

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Hash for Header

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<Header> for Header

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryRead<'_, &Header> for FrameContent

fn try_read(bytes: &[u8], header: &Header) -> Result<(Self, usize)>

Try to read from bytes using context.

impl TryRead<'_, ()> for Header

fn try_read(bytes: &[u8], _ctx: ()) -> Result<(Self, usize)>

Try to read from bytes using context.

impl<AEADBLKCIPH, KEYDESCLO> TryWrite<&Option<&mut SecurityContext<AEADBLKCIPH, KEYDESCLO>>> for Header where
    AEADBLKCIPH: NewBlockCipher + BlockCipher<BlockSize = U16>,
    KEYDESCLO: KeyDescriptorLookup<AEADBLKCIPH::KeySize>, 

fn try_write(
    self,
    bytes: &mut [u8],
    sec_ctx: &Option<&mut SecurityContext<AEADBLKCIPH, KEYDESCLO>>
) -> Result<usize>

Try to write to bytes using context.

impl Copy for Header

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header