Struct CreateNetworkOptions

pub struct CreateNetworkOptions<T>
where
    T: Into<String> + Eq + Hash,
{
    pub name: T,
    pub check_duplicate: bool,
    pub driver: T,
    pub internal: bool,
    pub attachable: bool,
    pub ingress: bool,
    pub ipam: Ipam,
    pub enable_ipv6: bool,
    pub options: HashMap<T, T>,
    pub labels: HashMap<T, T>,
}

Network configuration used in the Create Network API

Fields

name: T

The network’s name.

check_duplicate: bool

Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions.

driver: T

Name of the network driver plugin to use.

internal: bool

Restrict external access to the network.

attachable: bool

Globally scoped network is manually attachable by regular containers from workers in swarm mode.

ingress: bool

Ingress network is the network which provides the routing-mesh in swarm mode.

ipam: Ipam

Controls IP address management when creating a network.

enable_ipv6: bool

Enable IPv6 on the network.

options: HashMap<T, T>

Network specific options to be used by the drivers.

labels: HashMap<T, T>

User-defined key/value metadata.

Trait Implementations

impl<T> Clone for CreateNetworkOptions<T>

where T: Into<String> + Eq + Hash + Clone,

fn clone(&self) -> CreateNetworkOptions<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CreateNetworkOptions<T>

where T: Into<String> + Eq + Hash + Debug,

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

Formats the value using the given formatter.

impl<T> Default for CreateNetworkOptions<T>

where T: Into<String> + Eq + Hash + Default,

fn default() -> CreateNetworkOptions<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for CreateNetworkOptions<T>

where T: Into<String> + Eq + Hash + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> PartialEq for CreateNetworkOptions<T>

where T: Into<String> + Eq + Hash + PartialEq,

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

where T: Into<String> + Eq + Hash + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for CreateNetworkOptions<T>

where T: Into<String> + Eq + Hash,