Struct capsule::packets::ip::v6::Fragment

pub struct Fragment<E: Ipv6Packet> { /* fields omitted */ }

IPv6 Fragment Extension packet based on IETF RFC 8200.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|  Next Header  |   Reserved    |      Fragment Offset    |Res|M|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         Identification                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

• Next Header: 8-bit selector. Identifies the initial header type of the Fragmentable Part of the original packet. Uses the same values as the IPv4 Protocol field [IANA-PN].

• Reserved: 8-bit reserved field. Initialized to zero for transmission; ignored on reception.

• Fragment Offset: 13-bit unsigned integer. The offset, in 8-octet units, of the data following this header, relative to the start of the Fragmentable Part of the original packet.

• Res: 2-bit reserved field. Initialized to zero for transmission; ignored on reception.

• M flag: 1 = more fragments; 0 = last fragment.

• Identification: 32 bits.

Remarks

Because the payload following the fragment header is incomplete data, push and remove should be used with care. The result is likely not a valid packet without additional fixes.

Implementations

impl<E: Ipv6Packet> Fragment<E>

pub fn fragment_offset(&self) -> u16

Returns the offset of the data following this header relative to the start of the fragmentable part of the original packet. It is measured in units of 8 octets or 64 bits.

pub fn set_fragment_offset(&mut self, offset: u16)

Sets the fragment offset.

pub fn more_fragments(&self) -> bool

Returns a flag indicating whether there are more fragments.

pub fn set_more_fragments(&mut self)

Sets the more fragment flag indicating there are more fragments.

pub fn unset_more_fragments(&mut self)

Unsets the more fragment flag indicating this is the last fragment.

pub fn identification(&self) -> u32

Returns the identifying value assigned by the sender to aid in assembling the fragments of a packet.

pub fn set_identification(&mut self, identification: u32)

Sets the identifying value.

Trait Implementations

impl<E: Ipv6Packet> Debug for Fragment<E>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<E: Ipv6Packet> IpPacket for Fragment<E>

fn next_protocol(&self) -> ProtocolNumber

Returns the assigned protocol number of the packet immediately follows.

fn set_next_protocol(&mut self, proto: ProtocolNumber)

Sets the protocol number of the packet immediately follows.

fn src(&self) -> IpAddr

Returns the source IP address

fn set_src(&mut self, src: IpAddr) -> Fallible<()>

Sets the source IP address

fn dst(&self) -> IpAddr

Returns the destination IP address

fn set_dst(&mut self, dst: IpAddr) -> Fallible<()>

Sets the destination IP address.

fn pseudo_header(
    &self,
    packet_len: u16,
    protocol: ProtocolNumber
) -> PseudoHeader

Returns the pseudo-header for layer 4 checksum computation.

fn truncate(&mut self, mtu: usize) -> Fallible<()>

Truncates the IP packet to MTU. The data exceeds MTU is lost.

impl<E: Ipv6Packet> Ipv6Packet for Fragment<E>

fn next_header(&self) -> ProtocolNumber

Returns the next header type.

fn set_next_header(&mut self, next_header: ProtocolNumber)

Sets the next header type.

impl<E: Ipv6Packet> Packet for Fragment<E>

type Envelope = E

The preceding type for an IPv6 fragment packet can be either an IPv6 packet or any possible IPv6 extension packets.

fn envelope(&self) -> &Self::Envelope

Returns a reference to the envelope.

fn envelope_mut(&mut self) -> &mut Self::Envelope

Returns a mutable reference to the envelope.

fn offset(&self) -> usize

Returns the buffer offset where the current packet begins.

fn header_len(&self) -> usize

Returns the length of the packet header.

unsafe fn clone(&self, internal: Internal) -> Self

Returns a copy of the packet.

fn try_parse(envelope: Self::Envelope, _internal: Internal) -> Fallible<Self>

Parses the envelope's payload as an IPv6 fragment packet.

next_header of the envelope must be set to ProtocolNumbers::Ipv6Frag. Otherwise a parsing error is returned.

fn try_push(envelope: Self::Envelope, _internal: Internal) -> Fallible<Self>

Prepends an IPv6 fragment packet to the beginning of the envelope's payload.

next_header is set to the value of the next_header field of the envelope, and the envelope is set to ProtocolNumbers::Ipv6Frag.

fn remove(self) -> Fallible<Self::Envelope>

Removes IPv6 fragment packet from the message buffer.

The envelope's next_header field is set to the value of the next_header field on the fragment packet.

fn deparse(self) -> Self::Envelope

Deparses the packet back to the envelope's packet type.

fn mbuf(&self) -> &Mbuf

Returns a reference to the raw message buffer.

fn mbuf_mut(&mut self) -> &mut Mbuf

Returns a mutable reference to the raw message buffer.

fn payload_offset(&self) -> usize

Returns the buffer offset where the packet payload begins.

fn len(&self) -> usize

Returns the length of the packet with the payload.

fn payload_len(&self) -> usize

Returns the length of the packet payload.

fn parse<T: Packet<Envelope = Self>>(self) -> Fallible<T> where
    Self: Sized, 

Parses the packet's payload as a packet of type T.

fn peek<T: Packet<Envelope = Self>>(&self) -> Fallible<Immutable<T>> where
    Self: Sized, 

Peeks into the packet's payload as a packet of type T.

fn push<T: Packet<Envelope = Self>>(self) -> Fallible<T> where
    Self: Sized, 

Prepends a new packet of type T to the beginning of the envelope's payload.

fn remove_payload(&mut self) -> Fallible<()>

Removes the packet's payload from the message buffer.

fn reset(self) -> Mbuf where
    Self: Sized, 

Resets the parsed packet back to Mbuf.

fn reconcile(&mut self)

Reconciles the derivable header fields against the changes made to the packet.

fn reconcile_all(&mut self)

Reconciles against the changes recursively through all layers.