Struct Ipv6Packet

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

An IPv6 packet.

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

Implementations

impl<B: SplitByteSlice> Ipv6Packet<B>

pub fn iter_extension_hdrs( &self, ) -> impl Iterator<Item = Ipv6ExtensionHeader<'_>>

Returns an iterator over the extension headers.

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

The packet body.

pub fn dscp_and_ecn(&self) -> DscpAndEcn

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

pub fn flowlabel(&self) -> u32

The flow label.

pub fn proto(&self) -> Ipv6Proto

The Upper layer protocol for this packet.

This is found in the fixed header’s Next Header if there are no extension headers, or the Next Header value in the last extension header if there are. This also uses the same codes, encoded by the Rust type Ipv6Proto.

pub fn src_ipv6(&self) -> Option<Ipv6SourceAddr>

The source IP address represented as an Ipv6SourceAddr.

Unlike [IpHeader::src_ip], src_ipv6 returns an Ipv6SourceAddr, which represents the valid values that a source address can take (namely, a unicast or unspecified address) or None if the address is invalid (namely, a multicast address or an ipv4-mapped-ipv6 address).

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

Return a buffer that is a copy of the header bytes in this packet, including the fixed and extension headers, but without the first fragment extension header.

Note, if there are multiple fragment extension headers, only the first fragment extension header will be removed.

Panics

Panics if there is no fragment extension header in this packet.

pub fn builder(&self) -> Ipv6PacketBuilder

Construct a builder with the same contents as this packet.

pub fn nat64_translate( &self, v4_src_addr: Ipv4Addr, v4_dst_addr: Ipv4Addr, ) -> 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 IPv4 equivalent of this IPv6 packet. If the payload is a TCP segment or a UDP packet, its checksum will be updated. If the payload is an ICMPv6 packet, it will be converted to the equivalent ICMPv4 packet. For all other payloads, the payload will be unchanged, and the 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 IPv4 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 translating a particular IP protocol.

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

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

impl<B: SplitByteSliceMut> Ipv6Packet<B>

pub fn set_src_ip(&mut self, addr: Ipv6Addr)

Set the source IP address.

pub fn set_dst_ip(&mut self, addr: Ipv6Addr)

Set the destination IP address.

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

Set the hop limit.

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

The packet body.

Trait Implementations

impl<B: SplitByteSlice> Debug for Ipv6Packet<B>

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

Formats the value using the given formatter.

impl<B: SplitByteSlice> FromRaw<Ipv6PacketRaw<B>, ()> for Ipv6Packet<B>

type Error = IpParseError<Ipv6>

The type of error that may happen during validation.

fn try_from_raw_with( raw: Ipv6PacketRaw<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 Ipv6Packet<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, Ipv6> for Ipv6Packet<B>

type Builder = Ipv6PacketBuilder

A builder for this packet type.

type VersionSpecificMeta = ()

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

fn src_ip(&self) -> Ipv6Addr

The source IP address.

fn dst_ip(&self) -> Ipv6Addr

The destination IP address.

fn proto(&self) -> Ipv6Proto

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)

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

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

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<Ipv6, ()>

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> Ipv6Header for Ipv6Packet<B>

fn get_fixed_header(&self) -> &FixedHeader

Gets a reference to the IPv6 FixedHeader.

fn hop_limit(&self) -> u8

The Hop Limit.

fn next_header(&self) -> u8

The Next Header.

fn src_ip(&self) -> Ipv6Addr

The source IP address.

fn dst_ip(&self) -> Ipv6Addr

The destination IP address.

fn dscp_and_ecn(&self) -> DscpAndEcn

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

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

type Error = IpParseError<Ipv6>

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