Struct compose_yml::v2::Network

pub struct Network {
    pub driver: Option<RawOr<String>>,
    pub driver_opts: BTreeMap<String, RawOr<String>>,
    pub external: Option<ExternalNetwork>,
    pub internal: bool,
    pub enable_ipv6: bool,
    pub labels: BTreeMap<String, RawOr<String>>,
    // some fields omitted
}

A service which will be managed by docker-compose.

Fields

driver: Option<RawOr<String>>

The name of the network driver to use.

driver_opts: BTreeMap<String, RawOr<String>>

Options to pass to the network driver.

external: Option<ExternalNetwork>

Mutually-exclusive with all other options.

TODO LOW: We could represent Network and ExternalNetwork as some kind of enum, but that might break in the future if things get more complicated. For now, we're sticking close to the file format even if it makes things a bit less idiomatic in Rust.

TODO LOW: Clear on merge if driver changes, like we do for Logging options.

internal: bool

Create a network which has no access to the outside world.

enable_ipv6: bool

Enable IPv6 for this network.

labels: BTreeMap<String, RawOr<String>>

Docker labels for this volume, specifying various sorts of custom metadata.

Trait Implementations

impl Debug for Network

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

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 PartialEq for Network

fn eq(&self, __arg_0: &Network) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Network) -> bool

This method tests for !=.

impl Eq for Network

impl Default for Network

fn default() -> Network

Returns the "default value" for a type.

impl InterpolateAll for Network

Recursive merge all fields in the structure.

fn interpolate_all(&mut self) -> Result<()>

Recursively walk over this type, interpolating all RawOr values containing references to the environment. The default implementation leaves a value unchanged.

impl MergeOverride for Network

Recursive merge all fields in the structure.

fn merge_override(&self, ovr: &Self) -> Self

Given this value and an override value, merge the override value into this one, producing a new value.