Struct NetworkInterfaces

pub struct NetworkInterfaces { /* private fields */ }

Represents the collection of network interfaces defined in an interfaces(5) file.

The NetworkInterfaces struct provides methods to load, manipulate, and save network interface configurations.

Examples

Loading and modifying interfaces:

use interface_rs::NetworkInterfaces;
use interface_rs::interface::Interface;

let mut net_ifaces = NetworkInterfaces::load("tests/interfaces").unwrap();

// Modify an interface
if let Some(iface) = net_ifaces.get_interface_mut("eth0") {
    iface.method = Some("static".to_string());
    iface.options.push(("address".to_string(), "192.168.1.100".to_string()));
}

// Save changes
net_ifaces.save().unwrap();

Implementations

impl NetworkInterfaces

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, NetworkInterfacesError>

Loads the interfaces(5) file into memory.

Arguments

• path - The path to the interfaces file.

Returns

A NetworkInterfaces instance containing the parsed interfaces.

Errors

Returns a NetworkInterfacesError if the file cannot be read or parsed.

pub fn get_interface(&self, name: &str) -> Option<&Interface>

Retrieves a reference to an interface by name.

Arguments

• name - The name of the interface.

Returns

An Option containing a reference to the Interface if found.

pub fn get_interface_mut(&mut self, name: &str) -> Option<&mut Interface>

Retrieves a mutable reference to an interface by name.

Arguments

• name - The name of the interface.

Returns

An Option containing a mutable reference to the Interface if found.

pub fn add_interface(&mut self, iface: Interface)

Adds or updates an interface in the collection.

Arguments

• iface - The Interface to add or update.

pub fn delete_interface(&mut self, name: &str)

Deletes an interface by name.

Arguments

• name - The name of the interface to delete.

pub fn len(&self) -> usize

Returns the number of interfaces.

pub fn is_empty(&self) -> bool

Checks if the collection is empty.

pub fn next_unused_vlan_in_range(&self, start: u16, end: u16) -> Option<u16>

Finds the next unused VLAN ID within a specified range.

Arguments

• start - The starting VLAN ID (inclusive).
• end - The ending VLAN ID (inclusive).

Returns

• Option<u16> - The next unused VLAN ID, or None if all are used.

pub fn get_existing_vni_vlan(&self, vni_id: u32) -> Option<u16>

Retrieves the VLAN associated with an existing VNI interface.

Arguments

• vni_id - The VNI ID to search for (e.g., 1347682).

Returns

• Option<u16> - The VLAN ID specified in the bridge-access option, or None if the interface does not exist or the option is not present.

pub fn get_bridge_interfaces(&self) -> Vec<String>

Retrieves all port names that have a bridge-access option defined.

Returns

A Vec<String> containing the names of the ports with bridge-access defined.

pub fn save(&mut self) -> Result<(), NetworkInterfacesError>

Saves changes back to the interfaces(5) file.

Errors

Returns a NetworkInterfacesError if the file cannot be written or has been modified on disk.

pub fn reload(&mut self) -> Result<(), NetworkInterfacesError>

Reloads the interfaces file from disk.

Errors

Returns a NetworkInterfacesError if the file cannot be read or parsed.

impl NetworkInterfaces

pub fn iter(&self) -> impl Iterator<Item = (&String, &Interface)>

Returns an iterator over the interfaces.

Trait Implementations

impl Debug for NetworkInterfaces

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

Formats the value using the given formatter.

impl Display for NetworkInterfaces

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

Formats the value using the given formatter.