embassy-net

Crates

git

Versions

default

Flavors

Struct embassy_net::Ieee802154Frame

pub struct Ieee802154Frame<T>
where T: AsRef<[u8]>,
{ /* private fields */ }
Expand description

A read/write wrapper around an IEEE 802.15.4 frame buffer.

Implementations§

§

impl<T> Frame<T>
where T: AsRef<[u8]>,

pub const fn new_unchecked(buffer: T) -> Frame<T>

Input a raw octet buffer with Ethernet frame structure.

pub fn new_checked(buffer: T) -> Result<Frame<T>, Error>

Shorthand for a combination of new_unchecked and check_len.

pub fn check_len(&self) -> Result<(), Error>

Ensure that no accessor method will panic if called. Returns Err(Error) if the buffer is too short.

pub fn into_inner(self) -> T

Consumes the frame, returning the underlying buffer.

pub fn frame_type(&self) -> FrameType

Return the FrameType field.

pub fn security_enabled(&self) -> bool

pub fn frame_pending(&self) -> bool

pub fn ack_request(&self) -> bool

pub fn pan_id_compression(&self) -> bool

pub fn sequence_number_suppression(&self) -> bool

pub fn ie_present(&self) -> bool

pub fn dst_addressing_mode(&self) -> AddressingMode

Return the destination addressing mode.

pub fn frame_version(&self) -> FrameVersion

Return the frame version.

pub fn src_addressing_mode(&self) -> AddressingMode

Return the source addressing mode.

pub fn sequence_number(&self) -> Option<u8>

Return the sequence number of the frame.

pub fn dst_pan_id(&self) -> Option<Pan>

Return the destination PAN field.

pub fn dst_addr(&self) -> Option<Address>

Return the destination address field.

pub fn src_pan_id(&self) -> Option<Pan>

Return the destination PAN field.

pub fn src_addr(&self) -> Option<Address>

Return the source address field.

pub fn security_level(&self) -> u8

Return the security level of the auxiliary security header.

pub fn key_identifier_mode(&self) -> u8

Return the key identifier mode used by the auxiliary security header.

pub fn frame_counter_suppressed(&self) -> bool

Return true when the frame counter in the security header is suppressed.

pub fn frame_counter(&self) -> Option<u32>

Return the frame counter field.

pub fn key_source(&self) -> Option<&[u8]>

Return the Key Source field.

pub fn key_index(&self) -> Option<u8>

Return the Key Index field.

pub fn message_integrity_code(&self) -> Option<&[u8]>

Return the Message Integrity Code (MIC).

pub fn mac_header(&self) -> &[u8]

Return the MAC header.

§

impl<'a, T> Frame<&'a T>
where T: AsRef<[u8]> + ?Sized,

pub fn payload(&self) -> Option<&'a [u8]>

Return a pointer to the payload.

§

impl<T> Frame<T>
where T: AsRef<[u8]> + AsMut<[u8]>,

pub fn set_frame_type(&mut self, frame_type: FrameType)

Set the frame type.

pub fn set_security_enabled(&mut self, val: bool)

pub fn set_frame_pending(&mut self, val: bool)

pub fn set_ack_request(&mut self, val: bool)

pub fn set_pan_id_compression(&mut self, val: bool)

pub fn set_frame_version(&mut self, version: FrameVersion)

Set the frame version.

pub fn set_sequence_number(&mut self, value: u8)

Set the frame sequence number.

pub fn set_dst_pan_id(&mut self, value: Pan)

Set the destination PAN ID.

pub fn set_dst_addr(&mut self, value: Address)

Set the destination address.

pub fn set_src_pan_id(&mut self, value: Pan)

Set the source PAN ID.

pub fn set_src_addr(&mut self, value: Address)

Set the source address.

pub fn payload_mut(&mut self) -> Option<&mut [u8]>

Return a mutable pointer to the payload.

Trait Implementations§

§

impl<T> Clone for Frame<T>
where T: Clone + AsRef<[u8]>,

§

fn clone(&self) -> Frame<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<T> Debug for Frame<T>
where T: Debug + AsRef<[u8]>,

§

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

Formats the value using the given formatter. Read more
§

impl<T> Display for Frame<T>
where T: AsRef<[u8]>,

§

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

Formats the value using the given formatter. Read more
§

impl<T> Format for Frame<T>
where T: AsRef<[u8]>,

§

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

Writes the defmt representation of self to fmt.

Auto Trait Implementations§

§

impl<T> Freeze for Frame<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Frame<T>
where T: RefUnwindSafe,

§

impl<T> Send for Frame<T>
where T: Send,

§

impl<T> Sync for Frame<T>
where T: Sync,

§

impl<T> Unpin for Frame<T>
where T: Unpin,

§

impl<T> UnwindSafe for Frame<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.