Struct embassy_net::Ieee802154Frame
pub struct Ieee802154Frame<T>{ /* private fields */ }
Expand description
A read/write wrapper around an IEEE 802.15.4 frame buffer.
Implementations§
§impl<T> Frame<T>
impl<T> Frame<T>
pub const fn new_unchecked(buffer: T) -> Frame<T>
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>
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>
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
pub fn into_inner(self) -> T
Consumes the frame, returning the underlying buffer.
pub fn frame_type(&self) -> FrameType
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
pub fn dst_addressing_mode(&self) -> AddressingMode
Return the destination addressing mode.
pub fn frame_version(&self) -> FrameVersion
pub fn frame_version(&self) -> FrameVersion
Return the frame version.
pub fn src_addressing_mode(&self) -> AddressingMode
pub fn src_addressing_mode(&self) -> AddressingMode
Return the source addressing mode.
pub fn sequence_number(&self) -> Option<u8>
pub fn sequence_number(&self) -> Option<u8>
Return the sequence number of the frame.
pub fn dst_pan_id(&self) -> Option<Pan>
pub fn dst_pan_id(&self) -> Option<Pan>
Return the destination PAN field.
pub fn src_pan_id(&self) -> Option<Pan>
pub fn src_pan_id(&self) -> Option<Pan>
Return the destination PAN field.
pub fn security_level(&self) -> u8
pub fn security_level(&self) -> u8
Return the security level of the auxiliary security header.
pub fn key_identifier_mode(&self) -> u8
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
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>
pub fn frame_counter(&self) -> Option<u32>
Return the frame counter field.
pub fn key_source(&self) -> Option<&[u8]>
pub fn key_source(&self) -> Option<&[u8]>
Return the Key Source field.
pub fn message_integrity_code(&self) -> Option<&[u8]>
pub fn message_integrity_code(&self) -> Option<&[u8]>
Return the Message Integrity Code (MIC).
pub fn mac_header(&self) -> &[u8]
pub fn mac_header(&self) -> &[u8]
Return the MAC header.
§impl<T> Frame<T>
impl<T> Frame<T>
pub fn set_frame_type(&mut self, frame_type: FrameType)
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)
pub fn set_frame_version(&mut self, version: FrameVersion)
Set the frame version.
pub fn set_sequence_number(&mut self, value: u8)
pub fn set_sequence_number(&mut self, value: u8)
Set the frame sequence number.
pub fn set_dst_pan_id(&mut self, value: Pan)
pub fn set_dst_pan_id(&mut self, value: Pan)
Set the destination PAN ID.
pub fn set_dst_addr(&mut self, value: Address)
pub fn set_dst_addr(&mut self, value: Address)
Set the destination address.
pub fn set_src_pan_id(&mut self, value: Pan)
pub fn set_src_pan_id(&mut self, value: Pan)
Set the source PAN ID.
pub fn set_src_addr(&mut self, value: Address)
pub fn set_src_addr(&mut self, value: Address)
Set the source address.
pub fn payload_mut(&mut self) -> Option<&mut [u8]>
pub fn payload_mut(&mut self) -> Option<&mut [u8]>
Return a mutable pointer to the payload.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)