Struct Flow 

pub struct Flow {

    pub command: FlowCommand,
    pub table_id: u8,
    pub priority: u16,
    pub cookie: u64,
    pub cookie_mask: u64,
    pub match_fields: Match,
    pub actions: ActionList,
    pub instructions: InstructionList,
    pub idle_timeout: u16,
    pub hard_timeout: u16,
    pub flags: FlowFlags,
    pub out_port: Option<u32>,
    pub out_group: Option<u32>,
    pub buffer_id: Option<u32>,
}

A flow entry to add, modify, or delete.

Fields

command: FlowCommand

Command (add, modify, delete)

table_id: u8

Table ID (0xff for all tables on delete)

priority: u16

Priority

cookie: u64

Cookie

cookie_mask: u64

Cookie mask (for modify/delete)

match_fields: Match

Match fields

actions: ActionList

Actions (wrapped in ApplyActions instruction if instructions is empty)

instructions: InstructionList

Instructions (OF 1.3+, takes precedence over actions if set)

idle_timeout: u16

Idle timeout

hard_timeout: u16

Hard timeout

flags: FlowFlags

Flags

out_port: Option<u32>

Output port (for delete commands)

out_group: Option<u32>

Output group (for delete commands)

buffer_id: Option<u32>

Buffer ID (for packet-out)

Implementations

impl Flow

pub fn add() -> Self

Create a new flow add command.

pub fn delete() -> Self

Create a new flow delete command.

pub fn table(self, id: u8) -> Self

Set the table ID.

pub fn priority(self, priority: u16) -> Self

Set the priority.

pub fn cookie(self, cookie: u64) -> Self

Set the cookie.

pub fn match_fields(self, m: Match) -> Self

Set the match fields.

pub fn actions(self, actions: ActionList) -> Self

Set the actions (will be wrapped in ApplyActions instruction).

pub fn instructions(self, instructions: InstructionList) -> Self

Set the instructions directly (OF 1.3+).

pub fn idle_timeout(self, timeout: u16) -> Self

Set the idle timeout.

pub fn hard_timeout(self, timeout: u16) -> Self

Set the hard timeout.

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

Encode the complete FlowMod body (without OF header).

Returns: fixed fields (40) + match (variable) + instructions (variable)

pub fn to_message(&self, version: Version, xid: u32) -> Message

Create a complete OpenFlow message for this FlowMod.

Arguments

• version - OpenFlow version (should be 1.3+)
• xid - Transaction ID

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flow

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

Formats the value using the given formatter.