Skip to main content

TopLevelNetwork

Struct TopLevelNetwork 

Source
pub struct TopLevelNetwork {
    pub external: Option<bool>,
    pub name: Option<String>,
    pub internal: Option<bool>,
    pub driver: Option<String>,
    pub attachable: Option<bool>,
    pub enable_ipv6: Option<bool>,
    pub ipam: Option<Ipam>,
    pub driver_opts: Option<BTreeMap<String, Option<SingleValue>>>,
    pub labels: Option<ListOrMap>,
    /* private fields */
}
Expand description

Network configuration for the Compose application.

See more: https://docs.docker.com/reference/compose-file/networks/

Fields§

§external: Option<bool>

If set to true, it specifies that this network’s lifecycle is maintained outside of that of the application. Compose doesn’t attempt to create these networks, and returns an error if one doesn’t exist.

See more: https://docs.docker.com/reference/compose-file/networks/#external

§name: Option<String>

Custom name for this network.

See more: https://docs.docker.com/reference/compose-file/networks/#name

§internal: Option<bool>

By default, Compose provides external connectivity to networks. internal, when set to true, lets you create an externally isolated network.

§driver: Option<String>

Specifies which driver should be used for this network. Compose returns an error if the driver is not available on the platform.

For more information on drivers and available options, see Network drivers.

§attachable: Option<bool>

If attachable is set to true, then standalone containers should be able to attach to this network, in addition to services. If a standalone container attaches to the network, it can communicate with services and other standalone containers that are also attached to the network.

§enable_ipv6: Option<bool>

Enables IPv6 address assignment.

§ipam: Option<Ipam>

Specifies a custom IPAM configuration.

See more: https://docs.docker.com/reference/compose-file/networks/#ipam

§driver_opts: Option<BTreeMap<String, Option<SingleValue>>>

A list of options as key-value pairs to pass to the driver. These options are driver-dependent.

Consult the network drivers documentation for more information.

§labels: Option<ListOrMap>

Trait Implementations§

Source§

impl Clone for TopLevelNetwork

Source§

fn clone(&self) -> TopLevelNetwork

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TopLevelNetwork

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TopLevelNetwork

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TopLevelNetwork

Source§

fn eq(&self, other: &TopLevelNetwork) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for TopLevelNetwork

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TopLevelNetwork

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,