Struct smoltcp::wire::UdpPacket

pub struct UdpPacket<T: AsRef<[u8]>> { /* private fields */ }

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

Implementations

impl<T: AsRef<[u8]>> Packet<T>

pub fn new_unchecked(buffer: T) -> Packet<T>

Imbue a raw octet buffer with UDP packet structure.

pub fn new_checked(buffer: T) -> Result<Packet<T>>

Shorthand for a combination of new_unchecked and check_len.

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

Ensure that no accessor method will panic if called. Returns Err(Error::Truncated) if the buffer is too short. Returns Err(Error::Malformed) if the length field has a value smaller than the header length.

The result of this check is invalidated by calling set_len.

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

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: &IpAddress, dst_addr: &IpAddress) -> bool

Validate the packet checksum.

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.

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

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

Return a pointer to the payload.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

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: &IpAddress, dst_addr: &IpAddress)

Compute and fill in the header 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<T: AsRef<[u8]>> AsRef<[u8]> for Packet<T>

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

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

impl<T: Clone + AsRef<[u8]>> Clone for Packet<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<[u8]>> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<'a, T: AsRef<[u8]> + ?Sized> Display for Packet<&'a T>

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

Formats the value using the given formatter.

impl<T: PartialEq + AsRef<[u8]>> PartialEq<Packet<T>> for Packet<T>

fn eq(&self, other: &Packet<T>) -> 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<T: AsRef<[u8]>> PrettyPrint for Packet<T>

fn pretty_print(
    buffer: &dyn AsRef<[u8]>,
    f: &mut Formatter<'_>,
    indent: &mut PrettyIndent
) -> Result

Write a concise, formatted representation of a packet contained in the provided buffer, and any nested packets it may contain.

impl<T: AsRef<[u8]>> StructuralPartialEq for Packet<T>