Struct smoltcp::wire::Ipv4Packet

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

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

Methods

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

fn new(buffer: T) -> Packet<T>

Imbue a raw octet buffer with IPv4 packet structure.

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

Shorthand for a combination of new and check_len.

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

fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

fn version(&self) -> u8

Return the version field.

fn header_len(&self) -> u8

Return the header length, in octets.

fn dscp(&self) -> u8

Return the Differential Services Code Point field.

fn ecn(&self) -> u8

Return the Explicit Congestion Notification field.

fn total_len(&self) -> u16

Return the total length field.

fn ident(&self) -> u16

Return the fragment identification field.

fn dont_frag(&self) -> bool

Return the "don't fragment" flag.

fn more_frags(&self) -> bool

Return the "more fragments" flag.

fn frag_offset(&self) -> u16

Return the fragment offset, in octets.

fn ttl(&self) -> u8

Return the time to live field.

fn protocol(&self) -> Protocol

Return the protocol field.

fn checksum(&self) -> u16

Return the header checksum field.

fn src_addr(&self) -> Address

Return the source address field.

fn dst_addr(&self) -> Address

Return the destination address field.

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>

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

Return a pointer to the payload.

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

fn set_version(&mut self, value: u8)

Set the version field.

fn set_header_len(&mut self, value: u8)

Set the header length, in octets.

fn set_dscp(&mut self, value: u8)

Set the Differential Services Code Point field.

fn set_ecn(&mut self, value: u8)

Set the Explicit Congestion Notification field.

fn set_total_len(&mut self, value: u16)

Set the total length field.

fn set_ident(&mut self, value: u16)

Set the fragment identification field.

fn clear_flags(&mut self)

Clear the entire flags field.

fn set_dont_frag(&mut self, value: bool)

Set the "don't fragment" flag.

fn set_more_frags(&mut self, value: bool)

Set the "more fragments" flag.

fn set_frag_offset(&mut self, value: u16)

Set the fragment offset, in octets.

fn set_ttl(&mut self, value: u8)

Set the time to live field.

fn set_protocol(&mut self, value: Protocol)

Set the protocol field.

fn set_checksum(&mut self, value: u16)

Set the header checksum field.

fn set_src_addr(&mut self, value: Address)

Set the source address field.

fn set_dst_addr(&mut self, value: Address)

Set the destination address field.

fn fill_checksum(&mut self)

Compute and fill in the header checksum.

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

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

Return a mutable pointer to the payload.

Trait Implementations

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

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

fn pretty_print(
    buffer: &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.