Struct Packet

pub struct Packet<T> { /* private fields */ }

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

Implementations

impl<T: Payload> Packet<T>

pub fn new_checked(buffer: T, checksum: Checksum) -> Result<Self>

Shorthand for a combination of new_unchecked and check_len.

pub fn new_unchecked(buffer: T, repr: Repr) -> Self

Constructs a frame with assumed representation.

The validity of the frame is never a safety invariant but wrong data can still lead to inconsistent handling. In particular, wrong assumptions on the length may panic at runtime due to bounds checks.

pub fn get_ref(&self) -> &T

Get an immutable reference to the whole buffer.

Useful if the buffer is some other packet encapsulation.

pub fn repr(&self) -> Repr

Get the repr of the underlying frame.

pub fn into_inner(self) -> T

Consumes the frame, returning the underlying buffer.

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

where T: PayloadMut,

Return the payload as a mutable byte slice.

impl<T: Payload + PayloadMut> Packet<T>

pub fn fill_checksum(&mut self, checksum: Checksum)

Recalculate the checksum if necessary.

Note that the checksum test can be elided for non-Ipv6 upper layer protocol. This provides in opportunity to recalculate it if necessary even though the header structure is not otherwise mutably accessible while in Packet representation.

impl<'a, T: Payload + ?Sized> Packet<&'a T>

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

Return a pointer to the payload.

impl<T: Payload + PayloadMut> Packet<T>

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

Return a mutable pointer to the payload.

Methods from Deref<Target = udp>

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

Unwrap the packet as a raw byte slice.

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 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.

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_slice(&self) -> &[u8]

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> Clone for Packet<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<T: Payload> Deref for Packet<T>

type Target = udp

The resulting type after dereferencing.

fn deref(&self) -> &udp

Dereferences the value.

impl<T: Payload> Display for Packet<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Packet<T>

fn eq(&self, other: &Packet<T>) -> 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<T: Payload> Payload for Packet<T>

fn payload(&self) -> &payload

Get the bytes wrapped in the payload newtype.

impl<T: Payload + PayloadMut> PayloadMut for Packet<T>

fn payload_mut(&mut self) -> &mut payload

Retrieve the mutable, inner payload.

fn resize(&mut self, length: usize) -> Result<(), PayloadError>

Resize the payload.

fn reframe(&mut self, reframe: Reframe) -> Result<(), PayloadError>

Resize the payload while keeping some data.

impl<T> StructuralPartialEq for Packet<T>