Struct Network

pub struct Network {
    pub driver: Option<Driver>,
    pub driver_opts: IndexMap<MapKey, StringOrNumber>,
    pub attachable: bool,
    pub enable_ipv6: bool,
    pub ipam: Option<Ipam>,
    pub internal: bool,
    pub labels: ListOrMap,
    pub name: Option<String>,
    pub extensions: Extensions,
}

A named network which allows for Services to communicate with each other.

compose-spec

Fields

driver: Option<Driver>

Which driver to use for this network.

compose-spec

driver_opts: IndexMap<MapKey, StringOrNumber>

Driver-dependent options.

compose-spec

attachable: bool

Whether externally managed containers may attach to this network, in addition to Services.

compose-spec

enable_ipv6: bool

Whether to enable IPv6 networking.

compose-spec

ipam: Option<Ipam>

Custom IPAM configuration.

compose-spec

internal: bool

Whether to isolate this network from external connectivity.

compose-spec

labels: ListOrMap

Add metadata to the network.

compose-spec

name: Option<String>

Custom name for the network.

compose-spec

extensions: Extensions

Extension values, which are (de)serialized via flattening.

compose-spec

Implementations

impl Network

pub fn is_empty(&self) -> bool

Returns true if all fields are None, false, or empty.

The ipam field counts as empty if it is None or empty.

Examples

use compose_spec::{Network, network::Ipam};

let mut network = Network::default();
assert!(network.is_empty());

network.ipam = Some(Ipam::default());
assert!(network.is_empty());

network.ipam = Some(Ipam {
    driver: Some("driver".to_owned()),
    ..Ipam::default()
});
assert!(!network.is_empty());

Trait Implementations

impl Clone for Network

fn clone(&self) -> Network

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Network

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

Formats the value using the given formatter.

impl Default for Network

fn default() -> Network

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Network

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Network> for Resource<Network>

fn from(value: Network) -> Self

Converts to this type from the input type.

impl PartialEq for Network

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Network