Struct Flow 

pub struct Flow<T, D> {

    pub start_ts: Timestamp,
    pub last_ts: Timestamp,
    pub src_mac: EthAddr,
    pub dst_mac: EthAddr,
    pub eth_proto: EtherProto,
    pub tuple: T,
    pub ip_info: IpInfo,
    pub tcp_info: TcpInfo,
    pub u_bytes: usize,
    pub d_bytes: usize,
    pub u_payload_bytes: usize,
    pub d_payload_bytes: usize,
    pub u_pkts: u32,
    pub d_pkts: u32,
    pub u_payload_pkts: u32,
    pub d_payload_pkts: u32,
    pub u_frags: u32,
    pub d_frags: u32,
    pub data: D,
}

Fields

start_ts: Timestamp

Timestamp of the first packet in the flow.

last_ts: Timestamp

Timestamp of the last packet in the flow.

src_mac: EthAddr

Source MAC address.

dst_mac: EthAddr

Destination MAC address.

eth_proto: EtherProto

Ethernet protocol.

tuple: T

Generic address tuple (e.g. TupleV4, TupleV6 or TupleL2)

ip_info: IpInfo

IP layer statistics and info.

tcp_info: TcpInfo

TCP layer statistics and info (optional).

u_bytes: usize

Total uplink bytes.

d_bytes: usize

Total downlink bytes.

u_payload_bytes: usize

Total uplink payload bytes.

d_payload_bytes: usize

Total downlink payload bytes.

u_pkts: u32

Total uplink packets.

d_pkts: u32

Total downlink packets.

u_payload_pkts: u32

Uplink packets with payload.

d_payload_pkts: u32

Downlink packets with payload.

u_frags: u32

Uplink fragments count.

d_frags: u32

Downlink fragments count.

data: D

Custom data associated with the flow.

Implementations

impl<T, D> Flow<T, D>

where T: Default + Clone + Tuple + Sized, for<'a> NetworkLayer<'a>: SourceDestLayer<T::Addr>, T::Addr: Eq, D: Default,

pub fn new( timestamp: Timestamp, tuple: T, pkt: &Packet<'_>, dir: PacketDirection, ) -> Self

Creates a new Flow instance.

Arguments

• timestamp - The timestamp of the first packet in the flow.
• tuple - The flow tuple that identifies this connection (canonical direction).
• pkt - The initial packet that triggered flow creation.
• dir - The direction of the initial packet (Upwards or Downwards).

The source and destination MAC addresses and the tuple orientation are automatically adjusted based on the packet direction to ensure a consistent flow representation.

pub fn packet_dir(&self, pkt: &Packet<'_>) -> PacketDirection

Determines the direction of a packet relative to the flow.

Arguments

• pkt - The packet to analyze for direction determination.

A packet is considered “upwards” if both its source address and source port match the flow’s source tuple. Otherwise, it’s considered “downwards”. This method is essential for tracking bidirectional communication within a single flow instance.

Trait Implementations

impl<T: Clone, D: Clone> Clone for Flow<T, D>

fn clone(&self) -> Flow<T, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, D: Debug> Debug for Flow<T, D>

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

Formats the value using the given formatter.

impl<T: Default, D: Default> Default for Flow<T, D>

fn default() -> Flow<T, D>

Returns the “default value” for a type.

impl<'de, T, D> Deserialize<'de> for Flow<T, D>

where T: Deserialize<'de>, D: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq, D: PartialEq> PartialEq for Flow<T, D>

fn eq(&self, other: &Flow<T, D>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A, T> Process for Flow<A, T>

where T: Process,

fn process<Meta: PacketMetadata>( &mut self, meta: &Meta, pkt: &Packet<'_>, dir: PacketDirection, )

Update the state based on the provided packet metadata and content.

impl<T, D> Serialize for Flow<T, D>

where T: Serialize, D: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A, T> Trackable for Flow<A, T>

type Timestamp = Timestamp

fn timestamp(&self) -> Timestamp

fn set_timestamp(&mut self, ts: Self::Timestamp)

impl<T: Copy, D: Copy> Copy for Flow<T, D>

impl<T: Eq, D: Eq> Eq for Flow<T, D>

impl<T, D> StructuralPartialEq for Flow<T, D>