Struct CanonicalKey 

pub struct CanonicalKey {
    pub addr_a: IpAddr,
    pub addr_b: IpAddr,
    pub port_a: u16,
    pub port_b: u16,
    pub protocol: TransportProtocol,
    pub vlan_id: Option<u16>,
}

Bidirectional canonical conversation key.

Uses Wireshark-style canonical ordering: the smaller IP address is always addr_a with its corresponding port as port_a. This ensures that both directions of a conversation hash to the same key.

Fields

addr_a: IpAddr

The smaller IP address (or first if equal, then by port).

addr_b: IpAddr

The larger IP address.

port_a: u16

Port corresponding to addr_a.

port_b: u16

Port corresponding to addr_b.

protocol: TransportProtocol

Transport protocol.

vlan_id: Option<u16>

Optional VLAN ID for deinterlacing.

Implementations

impl CanonicalKey

pub fn new( src_ip: IpAddr, dst_ip: IpAddr, src_port: u16, dst_port: u16, protocol: TransportProtocol, vlan_id: Option<u16>, ) -> (Self, FlowDirection)

Create a new canonical key with deterministic ordering.

Returns the key and the direction of the original packet relative to the canonical ordering.

Trait Implementations

impl Clone for CanonicalKey

fn clone(&self) -> CanonicalKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalKey

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

Formats the value using the given formatter.

impl Display for CanonicalKey

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

Formats the value using the given formatter.

impl Hash for CanonicalKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CanonicalKey

fn eq(&self, other: &CanonicalKey) -> 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 Eq for CanonicalKey

impl StructuralPartialEq for CanonicalKey