Trait network_packet::IncomingNetworkPacket

pub trait IncomingNetworkPacket: Sized + Copy {
    fn free_direct_contiguous_packet(self);
    fn packet_length_if_contiguous(self) -> u16;
    fn offset_into_data<T>(self, offset: usize) -> NonNull<T>;
    fn hardware_offload_layer_2_packet_type(
        self
    ) -> HardwareOffloadLayer2PacketType;
    fn hardware_offload_layer_3_packet_type(
        self
    ) -> HardwareOffloadLayer3PacketType;
    fn hardware_offload_layer_4_packet_type(
        self
    ) -> HardwareOffloadLayer4PacketType;
    fn hardware_offload_tunnel_packet_type(
        self
    ) -> HardwareOffloadTunnelPacketType;
    fn hardware_offload_tunnel_inner_layer_2_packet_type(
        self
    ) -> HardwareOffloadLayer2PacketType;
    fn hardware_offload_tunnel_inner_layer_3_packet_type(
        self
    ) -> HardwareOffloadLayer3PacketType;
    fn hardware_offload_tunnel_inner_layer_4_packet_type(
        self
    ) -> HardwareOffloadLayer4PacketType;
    fn hardware_offload_internet_protocol_version_4_check_sum_status(
        self
    ) -> HardwareOffloadCheckSumStatus;
    fn hardware_offload_layer_4_check_sum_status(
        self
    ) -> HardwareOffloadCheckSumStatus;
    fn hardware_offload_categorisation_indicates_an_unwanted_packet(
        self
    ) -> bool;

    fn offset_into_data_reference<'a, T: 'a>(self, offset: usize) -> &'a T { ... }
}

Represents an incoming packet of contiguous data from a network card, with the Frame Check Sequence (FCS) (also known as Cyclic Redundancy Check, CRC) omitted.

Required Methods

fn free_direct_contiguous_packet(self)

Optimized routine that only works on direct, contiguous packets with a reference count of 1.

fn packet_length_if_contiguous(self) -> u16

Packet length if contiguous.

Same as data_length() for DPDK.

fn offset_into_data<T>(self, offset: usize) -> NonNull<T>

Offset into data, returned as a non-null pointer.

No length checks are made, although in debug builds an assertion may check.

A DPDK implementation would be a wrapper around rte_pktmbuf_mtod and rte_pktmbuf_mtod_offset.

Compare with DPDK's io_virtual_address_offset().

fn hardware_offload_layer_2_packet_type(self) -> HardwareOffloadLayer2PacketType

A network driver may support hardware offload categorisation of an incoming network packet.

This provides access to its categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_layer_3_packet_type(self) -> HardwareOffloadLayer3PacketType

A network driver may support hardware offload categorisation of an incoming network packet.

This provides access to its categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_layer_4_packet_type(self) -> HardwareOffloadLayer4PacketType

A network driver may support hardware offload categorisation of an incoming network packet.

This provides access to its categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_tunnel_packet_type(self) -> HardwareOffloadTunnelPacketType

A network driver may support hardware offload categorisation of an incoming network packet.

This provides access to its categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_tunnel_inner_layer_2_packet_type(
    self
) -> HardwareOffloadLayer2PacketType

A network driver may support hardware offload categorisation of an incoming network packet which is for a tunnel.

This provides access to a tunnel packet's inner categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_tunnel_inner_layer_3_packet_type(
    self
) -> HardwareOffloadLayer3PacketType

A network driver may support hardware offload categorisation of an incoming network packet which is for a tunnel.

This provides access to a tunnel packet's inner categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_tunnel_inner_layer_4_packet_type(
    self
) -> HardwareOffloadLayer4PacketType

A network driver may support hardware offload categorisation of an incoming network packet which is for a tunnel.

This provides access to a tunnel packet's inner categorisation, which can be used for short-circuiting some packet analysis.

Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.

fn hardware_offload_internet_protocol_version_4_check_sum_status(
    self
) -> HardwareOffloadCheckSumStatus

Determines the internet protocol (IP) version 4 check sum status.

fn hardware_offload_layer_4_check_sum_status(
    self
) -> HardwareOffloadCheckSumStatus

Determines the layer 4 (TCP, UDP, SCTP) check sum check sum status.

fn hardware_offload_categorisation_indicates_an_unwanted_packet(self) -> bool

Hardware offloading categorisation indicates an unwanted packet.

Provided Methods

fn offset_into_data_reference<'a, T: 'a>(self, offset: usize) -> &'a T

Offset into data, returned as a reference.

No length checks are made, although in debug builds an assertion may check.

Implementors