Struct Packet

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

A read/write wrapper around an Internet Protocol version 6 packet buffer.

Implementations

impl<T: Payload> Packet<T>

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

Shorthand for a combination of new_unchecked and check_len.

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

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

Create a new packet without checking the representation.

Misuse may lead to panics from out-of-bounds access or other subtle inconsistencies. Since the representation might not represent the actual content in the payload, this also might mean that seemingly inconsistent values are returned. The usage is still memory safe though.

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

Methods from Deref<Target = ipv6>

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

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

The result of this check is invalidated by calling set_payload_len.

pub fn header_len(&self) -> usize

Return the header length.

pub fn version(&self) -> u8

Return the version field.

pub fn traffic_class(&self) -> u8

Return the traffic class.

pub fn flow_label(&self) -> u32

Return the flow label field.

pub fn payload_len(&self) -> u16

Return the payload length field.

pub fn total_len(&self) -> usize

Return the payload length added to the known header length.

pub fn next_header(&self) -> Protocol

Return the next header field.

pub fn hop_limit(&self) -> u8

Return the hop limit field.

pub fn src_addr(&self) -> Address

Return the source address field.

pub fn dst_addr(&self) -> Address

Return the destination address field.

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

Return a pointer to the payload.

Trait Implementations

impl<T: Payload> 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 + Payload> 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 + Payload> 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 = ipv6

The resulting type after dereferencing.

fn deref(&self) -> &ipv6

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 + Payload> 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: 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: Payload> StructuralPartialEq for Packet<T>