Struct ActionList 

pub struct ActionList { /* private fields */ }

A list of actions.

Implementations

impl ActionList

pub fn new() -> Self

Create a new empty action list.

pub fn push(&mut self, action: Action)

Add an action to the list.

pub fn output(self, port: impl Into<OutputPort>) -> Self

Output to a port.

pub fn controller(self, max_len: u16) -> Self

Send to controller.

pub fn drop(self) -> Self

Drop the packet.

pub fn set_eth_dst(self, mac: [u8; 6]) -> Self

Set destination MAC.

pub fn set_eth_src(self, mac: [u8; 6]) -> Self

Set source MAC.

pub fn push_vlan(self, tpid: u16) -> Self

Push VLAN tag.

pub fn pop_vlan(self) -> Self

Pop VLAN tag.

pub fn set_vlan_vid(self, vid: u16) -> Self

Set VLAN ID.

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

Go to another table.

pub fn dec_ttl(self) -> Self

Decrement TTL.

pub fn flood(self) -> Self

Output to all ports except input port (flood).

pub fn all(self) -> Self

Output to all ports.

pub fn normal(self) -> Self

Output using normal L2/L3 switching.

pub fn in_port(self) -> Self

Output to ingress port.

pub fn set_tunnel_id(self, tunnel_id: u64) -> Self

Set tunnel ID (Nicira extension).

pub fn group(self, group_id: u32) -> Self

Output to group table.

pub fn resubmit(self, port: Option<u16>, table: Option<u8>) -> Self

Resubmit to another table (Nicira extension).

• port: Input port to use (None = current input port)
• table: Table to resubmit to (None = current table)

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

Resubmit to a specific table (Nicira extension).

Convenience method for resubmit(None, Some(table)).

pub fn ct(self, flags: u16, zone: u16, table: Option<u8>) -> Self

Connection tracking action (Nicira extension).

• flags: CT flags (commit, force, etc.)
• zone: CT zone ID
• table: Table to recirculate to after CT (None = no recirc)

pub fn ct_commit(self, zone: u16) -> Self

Connection tracking with commit (Nicira extension).

Commits the connection to the connection tracking table.

pub fn ct_nat( self, flags: u16, zone: u16, table: Option<u8>, nat: NatConfig, ) -> Self

Connection tracking with NAT (Nicira extension).

Performs connection tracking with Network Address Translation.

Arguments

• flags: CT flags (commit, force, etc.)
• zone: CT zone ID
• table: Table to recirculate to after CT (None = no recirc)
• nat: NAT configuration (SNAT or DNAT)

Example

use rovs_openflow::{ActionList, NatConfig, CT_COMMIT};
use std::net::Ipv4Addr;

// SNAT to 10.0.0.1
ActionList::new().ct_nat(
    CT_COMMIT,
    1,
    Some(2),
    NatConfig::snat(Ipv4Addr::new(10, 0, 0, 1)),
)

pub fn ct_snat(self, zone: u16, table: Option<u8>, addr: Ipv4Addr) -> Self

Connection tracking with SNAT (Nicira extension).

Source NAT: translates the source IP address.

Example

use std::net::Ipv4Addr;

// SNAT to 10.0.0.1, commit and recirculate to table 2
ActionList::new().ct_snat(
    1,                              // zone
    Some(2),                        // recirc table
    Ipv4Addr::new(10, 0, 0, 1),     // NAT address
)

pub fn ct_dnat(self, zone: u16, table: Option<u8>, addr: Ipv4Addr) -> Self

Connection tracking with DNAT (Nicira extension).

Destination NAT: translates the destination IP address.

Example

use std::net::Ipv4Addr;

// DNAT to 192.168.1.100:8080
ActionList::new().ct_dnat(
    1,
    Some(2),
    Ipv4Addr::new(192, 168, 1, 100),
)

pub fn learn(self, learn: NxLearn) -> Self

Learn action (Nicira extension).

Creates flows dynamically based on packet content.

pub fn move_field( self, src_field: u32, dst_field: u32, n_bits: u16, src_ofs: u16, dst_ofs: u16, ) -> Self

Move/copy bits between fields (Nicira extension).

Copies n_bits bits from src_field[src_ofs..] to dst_field[dst_ofs..]. Use NXM constants from the nxm module for field headers.

Example

// Copy ARP source IP to ARP target IP
actions.move_field(nxm::ARP_SPA, nxm::ARP_TPA, 32, 0, 0)

pub fn load_field( self, dst_field: u32, dst_ofs: u16, n_bits: u16, value: u64, ) -> Self

Load immediate value into field (Nicira extension).

Loads value into dst_field[dst_ofs..dst_ofs+n_bits]. Use NXM constants from the nxm module for field headers.

Example

// Set ARP opcode to 2 (reply)
actions.load_field(nxm::ARP_OP, 0, 16, 2)

pub fn set_arp_op(self, opcode: u16) -> Self

Set ARP opcode (Nicira extension).

Common values: 1 = request, 2 = reply

pub fn set_arp_spa(self, ip: u32) -> Self

Set ARP source protocol address (sender IP).

pub fn set_arp_tpa(self, ip: u32) -> Self

Set ARP target protocol address (target IP).

pub fn set_arp_sha(self, mac: u64) -> Self

Set ARP source hardware address (sender MAC).

Note: MAC is passed as a u64 with the MAC in the lower 48 bits.

pub fn set_arp_tha(self, mac: u64) -> Self

Set ARP target hardware address (target MAC).

Note: MAC is passed as a u64 with the MAC in the lower 48 bits.

pub fn actions(&self) -> &[Action]

Get the actions.

pub fn is_empty(&self) -> bool

Check if the list is empty.

pub fn len(&self) -> usize

Get the number of actions.

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

Encode all actions to wire format.

Actions are concatenated and padded to 8-byte alignment.

pub fn decode(data: &[u8]) -> Result<Self>

Decode all actions from wire format.

Reads actions until the data is exhausted.

Trait Implementations

impl Clone for ActionList

fn clone(&self) -> ActionList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionList

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

Formats the value using the given formatter.

impl Default for ActionList

fn default() -> ActionList

Returns the “default value” for a type.

impl Display for ActionList

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

Formats the value using the given formatter.