Struct smoltcp::wire::Ipv4Packet

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

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

Implementations

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

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

Imbue a raw octet buffer with IPv4 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 header length is greater than total length.

The result of this check is invalidated by calling set_header_len and set_total_len.

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

pub fn version(&self) -> u8

Return the version field.

pub fn header_len(&self) -> u8

Return the header length, in octets.

pub fn dscp(&self) -> u8

Return the Differential Services Code Point field.

pub fn ecn(&self) -> u8

Return the Explicit Congestion Notification field.

pub fn total_len(&self) -> u16

Return the total length field.

pub fn ident(&self) -> u16

Return the fragment identification field.

pub fn dont_frag(&self) -> bool

Return the “don’t fragment” flag.

pub fn more_frags(&self) -> bool

Return the “more fragments” flag.

pub fn frag_offset(&self) -> u16

Return the fragment offset, in octets.

pub fn hop_limit(&self) -> u8

Return the time to live field.

pub fn protocol(&self) -> Protocol

Return the protocol field.

pub fn checksum(&self) -> u16

Return the header checksum 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 verify_checksum(&self) -> bool

Validate the header checksum.

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_version(&mut self, value: u8)

Set the version field.

pub fn set_header_len(&mut self, value: u8)

Set the header length, in octets.

pub fn set_dscp(&mut self, value: u8)

Set the Differential Services Code Point field.

pub fn set_ecn(&mut self, value: u8)

Set the Explicit Congestion Notification field.

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

Set the total length field.

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

Set the fragment identification field.

pub fn clear_flags(&mut self)

Clear the entire flags field.

pub fn set_dont_frag(&mut self, value: bool)

Set the “don’t fragment” flag.

pub fn set_more_frags(&mut self, value: bool)

Set the “more fragments” flag.

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

Set the fragment offset, in octets.

pub fn set_hop_limit(&mut self, value: u8)

Set the time to live field.

pub fn set_protocol(&mut self, value: Protocol)

Set the protocol field.

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

Set the header checksum field.

pub fn set_src_addr(&mut self, value: Address)

Set the source address field.

pub fn set_dst_addr(&mut self, value: Address)

Set the destination address field.

pub fn fill_checksum(&mut self)

Compute and fill in the header checksum.

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: &Packet<T>) -> bool

This method tests for !=.

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>