Struct NetworkConfig 

pub struct NetworkConfig {
    pub name: String,
    pub subnet: String,
    pub gateway: Ipv4Addr,
    pub driver: String,
    pub labels: HashMap<String, String>,
    pub endpoints: HashMap<String, NetworkEndpoint>,
    pub created_at: String,
    pub policy: NetworkPolicy,
}

Configuration for a user-defined network.

Fields

name: String

Network name (unique identifier).

subnet: String

Subnet in CIDR notation (e.g., “10.88.0.0/24”).

gateway: Ipv4Addr

Gateway IP address (e.g., “10.88.0.1”).

driver: String

Network driver (currently only “bridge” is supported).

labels: HashMap<String, String>

User-defined labels.

endpoints: HashMap<String, NetworkEndpoint>

Connected endpoints (box_id → endpoint).

created_at: String

Creation timestamp (RFC 3339).

policy: NetworkPolicy

Network isolation policy.

Implementations

impl NetworkConfig

pub fn new(name: &str, subnet: &str) -> Result<Self, String>

Create a new network with the given name and subnet.

pub fn validate_runtime(&self) -> Result<(), String>

Validate the driver and policy that the runtime can enforce today.

pub fn connect( &mut self, box_id: &str, box_name: &str, ) -> Result<NetworkEndpoint, String>

Allocate an IP and register a new endpoint for a box.

pub fn connect_with_aliases( &mut self, box_id: &str, box_name: &str, aliases: &[String], ) -> Result<NetworkEndpoint, String>

Connect a box, also registering extra DNS aliases that resolve to its IP (e.g. the bare Compose service name in addition to the box name).

pub fn disconnect(&mut self, box_id: &str) -> Result<NetworkEndpoint, String>

Remove a box from this network.

pub fn set_policy(&mut self, policy: NetworkPolicy) -> Result<(), String>

Set the network policy, validating that it can be enforced.

Returns an error if the policy uses an isolation mode that is not yet implemented at the packet-filtering level.

pub fn connected_boxes(&self) -> Vec<&NetworkEndpoint>

Get all connected endpoints.

pub fn peer_endpoints(&self, exclude_box_id: &str) -> Vec<(String, String)>

Get peer endpoints for DNS discovery (all endpoints except the given box).

Returns (ip_address, box_name) pairs for all endpoints other than exclude_box_id.

pub fn allowed_peer_endpoints( &self, exclude_box_id: &str, ) -> Vec<(String, String)>

Get peer endpoints filtered by the network’s isolation policy.

Like peer_endpoints, but only returns peers that the given box is allowed to communicate with according to the network policy.

Trait Implementations

impl Clone for NetworkConfig

fn clone(&self) -> NetworkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NetworkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NetworkConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.