Struct DataFrame

pub struct DataFrame<'a, DataFramePayload = &'a [u8]> {
    pub header: DataFrameHeader,
    pub payload: Option<DataFramePayload>,
    pub _phantom: PhantomData<&'a ()>,
}

This is a data frame.

The individual subtypes don’t have there own seperate structs, since the only difference is the header.

Fields

header: DataFrameHeader

This is the header of the data frame.

payload: Option<DataFramePayload>

This is the payload of the data frame. It will be set to None for all null function frames. NOTE: This may be crypto wrapped, so using DataFrame::potentially_wrapped_payload is recommended.

_phantom: PhantomData<&'a ()>

Implementations

impl DataFrame<'_>

pub const fn length_in_bytes(&self) -> usize

The total length in bytes.

pub fn potentially_wrapped_payload( &self, mic_state: Option<MicState>, ) -> Option<PotentiallyWrappedPayload<DataFrameReadPayload<'_>>>

Get the potentially wrapped inner payload.

If the payload is protected, but mic_state is None, None will be returned.

impl<'a, P> DataFrame<'a, P>

pub fn crypto_wrap( self, crypto_header: CryptoHeader, mic_state: MicState, ) -> DataFrame<'a, CryptoWrapper<P>>

Wrap the payload in a CryptoWrapper.

impl<'a, KeyMic: AsRef<[u8]>, ElementContainer> DataFrame<'a, SnapLlcFrame<'a, EapolKeyFrame<'a, KeyMic, ElementContainer>>>

pub fn eapol_mic_range(&self) -> Option<Range<usize>>

Get the range in which the EAPOL MIC field is in the serialized data frame.

pub fn eapol_key_data_length_range(&self) -> Option<Range<usize>>

Get the range in which the EAPOL Key Data Length field is in the serialized data frame.

pub fn eapol_key_data_range(&self) -> Option<RangeFrom<usize>>

Get the range in which the EAPOL Key Data field is in the serialized data frame.

Trait Implementations

impl<'a, DataFramePayload: Clone> Clone for DataFrame<'a, DataFramePayload>

fn clone(&self) -> DataFrame<'a, DataFramePayload>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, DataFramePayload: Debug> Debug for DataFrame<'a, DataFramePayload>

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

Formats the value using the given formatter.

impl<'a, DataFramePayload: Default> Default for DataFrame<'a, DataFramePayload>

fn default() -> DataFrame<'a, DataFramePayload>

Returns the “default value” for a type.

impl<'a, DataFramePayload> Format for DataFrame<'a, DataFramePayload>

where DataFrameHeader: Format, Option<DataFramePayload>: Format, PhantomData<&'a ()>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<'a, DataFramePayload: Hash> Hash for DataFrame<'a, DataFramePayload>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Payload> IEEE80211Frame for DataFrame<'_, Payload>

const TYPE: FrameType

impl<DataFramePayload: MeasureWith<()>> MeasureWith<bool> for DataFrame<'_, DataFramePayload>

fn measure_with(&self, with_fcs: &bool) -> usize

How large is Self, given the ctx?

impl<'a, DataFramePayload: PartialEq> PartialEq for DataFrame<'a, DataFramePayload>

fn eq(&self, other: &DataFrame<'a, DataFramePayload>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> TryFromCtx<'a, bool> for DataFrame<'a>

type Error = Error

fn try_from_ctx( from: &'a [u8], with_fcs: bool, ) -> Result<(Self, usize), Self::Error>

impl<Payload: TryIntoCtx<Error = Error>> TryIntoCtx<bool> for DataFrame<'_, Payload>

type Error = Error

fn try_into_ctx( self, buf: &mut [u8], with_fcs: bool, ) -> Result<usize, Self::Error>

impl<'a, DataFramePayload: Copy> Copy for DataFrame<'a, DataFramePayload>

impl<'a, DataFramePayload: Eq> Eq for DataFrame<'a, DataFramePayload>

impl<'a, DataFramePayload> StructuralPartialEq for DataFrame<'a, DataFramePayload>