Struct Ipv4Packet

pub struct Ipv4Packet<B> { /* private fields */ }

An IPv4 packet.

An Ipv4Packet shares its underlying memory with the byte slice it was parsed from or serialized to, meaning that no copying or extra allocation is necessary.

An Ipv4Packet - whether parsed using parse or created using Ipv4PacketBuilder - maintains the invariant that the checksum is always valid.

Implementations

impl<B: SplitByteSlice> Ipv4Packet<B>

pub fn iter_options(&self) -> impl Iterator<Item = Ipv4Option<'_>>

Iterate over the IPv4 header options.

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

The packet body.

pub fn header_len(&self) -> usize

The size of the header prefix and options.

pub fn copy_header_bytes_for_fragment(&self) -> Vec<u8>

Return a buffer that is a copy of the header bytes in this packet, but patched to be not fragmented.

Return a buffer of this packet’s header and options with the fragment data zeroed out.

pub fn nat64_translate( &self, v6_src_addr: Ipv6Addr, v6_dst_addr: Ipv6Addr, ) -> Nat64TranslationResult<impl Serializer<Buffer = EmptyBuf> + Debug + '_, Nat64Error>

Performs the header translation part of NAT64 as described in RFC 7915.

nat64_translate follows the rules described in RFC 7915 to construct the IPv6 equivalent of this IPv4 packet. If the payload is a TCP segment or a UDP packet, its checksum will be updated. If the payload is an ICMPv4 packet, it will be converted to the equivalent ICMPv6 packet. For all other payloads, the payload will be unchanged, and IP header will be translated. On success, a [Serializer] is returned which describes the new packet to be sent.

Note that the IPv4 TTL/IPv6 Hop Limit field is not modified. It is the caller’s responsibility to decrement and process this field per RFC 7915.

In some cases, the packet has no IPv6 equivalent, in which case the value Nat64TranslationResult::Drop will be returned, instructing the caller to silently drop the packet.

Errors

nat64_translate will return an error if support has not yet been implemented for translation a particular IP protocol.

pub fn to_vec(&self) -> Vec<u8>

Copies the packet (Header + Options + Body) into a Vec.

impl<B: SplitByteSliceMut> Ipv4Packet<B>

pub fn set_src_ip_and_update_checksum(&mut self, addr: Ipv4Addr)

Set the source IP address.

Set the source IP address and update the header checksum accordingly.

pub fn set_dst_ip_and_update_checksum(&mut self, addr: Ipv4Addr)

Set the destination IP address.

Set the destination IP address and update the header checksum accordingly.

pub fn set_ttl(&mut self, ttl: u8)

Set the Time To Live (TTL).

Set the TTL and update the header checksum accordingly.

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

The packet body.

Trait Implementations

impl<B> Debug for Ipv4Packet<B>

where B: SplitByteSlice,

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

Formats the value using the given formatter.

impl<B: SplitByteSlice> FromRaw<Ipv4PacketRaw<B>, ()> for Ipv4Packet<B>

type Error = IpParseError<Ipv4>

The type of error that may happen during validation.

fn try_from_raw_with( raw: Ipv4PacketRaw<B>, _args: (), ) -> Result<Self, Self::Error>

Attempts to create Self from the raw form in raw with args.

fn try_from_raw(raw: R) -> Result<Self, Self::Error>

where Self: FromRaw<R, (), Error = Self::Error>,

Attempts to create Self from the raw form in raw.

impl<B: SplitByteSlice, I: IpExt> GenericOverIp<I> for Ipv4Packet<B>

type Type = <I as IpExt>::Packet<B>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<B: SplitByteSlice> IpPacket<B, Ipv4> for Ipv4Packet<B>

type Builder = Ipv4PacketBuilder

A builder for this packet type.

type VersionSpecificMeta = Ipv4OnlyMeta

Metadata which is only present in the packet format of a specific version of the IP protocol.

fn src_ip(&self) -> Ipv4Addr

The source IP address.

fn dst_ip(&self) -> Ipv4Addr

The destination IP address.

fn proto(&self) -> Ipv4Proto

The protocol number.

fn dscp_and_ecn(&self) -> DscpAndEcn

The Differentiated Services Code Point (DSCP) and the Explicit Congestion Notification (ECN).

fn ttl(&self) -> u8

The Time to Live (TTL) (IPv4) or Hop Limit (IPv6) field.

fn set_ttl(&mut self, ttl: u8)

where B: SplitByteSliceMut,

Set the Time to Live (TTL) (IPv4) or Hop Limit (IPv6) field.

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

Get the body.

fn version_specific_meta(&self) -> Ipv4OnlyMeta

Gets packet metadata relevant only for this version of the IP protocol.

fn as_ip_addr_ref(&self) -> IpAddr<&Self, &Ipv6Packet<B>>

Converts a packet reference into a dynamically-typed reference.

fn reassemble_fragmented_packet<BV: BufferViewMut<B>, IT: Iterator<Item = Vec<u8>>>( buffer: BV, header: Vec<u8>, body_fragments: IT, ) -> IpParseResult<Ipv4, ()>

where B: SplitByteSliceMut,

Reassembles a fragmented packet into a parsed IP packet.

fn to_vec(&self) -> Vec<u8>

Copies the full packet into a Vec.

fn into_metadata(self) -> (I::Addr, I::Addr, I::Proto, ParseMetadata)

Consume the packet and return some metadata.

impl<B: SplitByteSlice> Ipv4Header for Ipv4Packet<B>

fn get_header_prefix(&self) -> &HeaderPrefix

Gets a reference to the IPv4 HeaderPrefix.

fn dscp_and_ecn(&self) -> DscpAndEcn

The Differentiated Services Code Point (DSCP) and the Explicit Congestion Notification (ECN).

fn id(&self) -> u16

The identification.

fn df_flag(&self) -> bool

The Don’t Fragment (DF) flag.

fn mf_flag(&self) -> bool

The More Fragments (MF) flag.

fn fragment_offset(&self) -> FragmentOffset

The fragment offset.

fn fragment_type(&self) -> Ipv4FragmentType

The fragment type.

fn ttl(&self) -> u8

The Time To Live (TTL).

fn proto(&self) -> Ipv4Proto

The IP Protocol.

fn src_ip(&self) -> Ipv4Addr

The source IP address.

fn dst_ip(&self) -> Ipv4Addr

The destination IP address.

fn builder(&self) -> Ipv4PacketBuilder

Construct a builder with the same contents as this header.

impl<B: SplitByteSlice> ParsablePacket<B, ()> for Ipv4Packet<B>

type Error = IpParseError<Ipv4>

The type of errors returned from parse and parse_mut.

fn parse_metadata(&self) -> ParseMetadata

Gets metadata about this packet required by [GrowBuffer::undo_parse].

fn parse<BV: BufferView<B>>(buffer: BV, _args: ()) -> IpParseResult<Ipv4, Self>

Parses a packet from a buffer.

fn parse_mut<BV>(buffer: BV, args: ParseArgs) -> Result<Self, Self::Error>

where BV: BufferViewMut<B>, B: SplitByteSliceMut,

Parses a packet from a mutable buffer.