Struct UdpPacket 

pub struct UdpPacket<'a> { /* private fields */ }

A read/write wrapper around an User Datagram Protocol packet buffer.

Implementations

impl<'a> Packet<'a>

pub const fn new_unchecked(buffer: &'a mut [u8]) -> Packet<'a>

Imbue a raw octet buffer with UDP packet structure.

pub fn new_checked(buffer: &'a mut [u8]) -> Result<Packet<'a>, 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. Returns Err(Error) if the length field has a value smaller than the header length, or larger than the buffer.

The result of this check is invalidated by calling set_len.

pub fn src_port(&self) -> u16

Return the source port field.

pub fn dst_port(&self) -> u16

Return the destination port field.

pub fn len(&self) -> u16

Return the length field.

pub fn checksum(&self) -> u16

Return the checksum field.

pub fn verify_checksum(&self, src_addr: &Address, dst_addr: &Address) -> bool

Validate the packet checksum.

An all-zeroes checksum field means the transmitter didn’t generate one. That is accepted on UDP-over-IPv4, and rejected on UDP-over-IPv6, which requires checksums (RFC 8200 § 8.1).

Panics

This function panics unless src_addr and dst_addr belong to the same family, and that family is IPv4 or IPv6.

Fuzzing

This function always returns true when fuzzing.

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

Return a pointer to the payload.

pub fn set_src_port(&mut self, value: u16)

Set the source port field.

pub fn set_dst_port(&mut self, value: u16)

Set the destination port field.

pub fn set_len(&mut self, value: u16)

Set the length field.

pub fn set_checksum(&mut self, value: u16)

Set the checksum field.

pub fn fill_checksum(&mut self, src_addr: &Address, dst_addr: &Address)

Compute and fill in the checksum.

Panics

This function panics unless src_addr and dst_addr belong to the same family, and that family is IPv4 or IPv6.

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

Return a mutable pointer to the payload.

Trait Implementations

impl<'a> AsRef<[u8]> for Packet<'a>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for Packet<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Packet<'a>

impl<'a> Format for Packet<'a>

where &'a mut [u8]: Format,

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

Writes the defmt representation of self to fmt.

impl<'a> PartialEq for Packet<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Packet<'a>