NetworkCreateOptions

Struct NetworkCreateOptions 

Source
pub struct NetworkCreateOptions {
    pub name: String,
    pub check_duplicate: bool,
    pub driver: String,
    pub internal: bool,
    pub attachable: bool,
    pub ingress: bool,
    pub ipam: IPAM,
    pub enable_ipv6: bool,
    pub options: HashMap<String, String>,
    pub labels: HashMap<String, String>,
}
Expand description

request body of /networks/create api

Fields§

§name: String§check_duplicate: bool§driver: String§internal: bool

Restrict connections between containers to only those under the same network. Default false

§attachable: bool§ingress: bool§ipam: IPAM§enable_ipv6: bool§options: HashMap<String, String>§labels: HashMap<String, String>

Implementations§

Source§

impl NetworkCreateOptions

Create network options

To create a network equivalent to the default bridge network, set the options as follows:

let network_name = "sample-network";
let mut opt = NetworkCreateOptions::new(network_name);
opt.enable_icc()
    .enable_ip_masquerade()
    .host_binding_ipv4(Ipv4Addr::new(0, 0, 0, 0))
    .bridge_name("docker0")
    .driver_mtu(1500);
// let network = docker.create_network(&opt)?;
Source

pub fn new(name: &str) -> Self

equivalent to docker network create <name>

Source

pub fn bridge_name(&mut self, name: &str) -> &mut Self

bridge name to be used when creating the Linux bridge

Source

pub fn enable_ip_masquerade(&mut self) -> &mut Self

equivalent to --ip-masq of dockerd flag

Source

pub fn enable_icc(&mut self) -> &mut Self

equivalent to --icc of dockerd flag

Source

pub fn host_binding_ipv4(&mut self, ipv4: Ipv4Addr) -> &mut Self

equivalent to --ip of dockerd flag

Source

pub fn driver_mtu(&mut self, mtu: u16) -> &mut Self

equivalent to --mtu option

Source

pub fn label(&mut self, key: &str, value: &str) -> &mut Self

Trait Implementations§

Source§

impl Clone for NetworkCreateOptions

Source§

fn clone(&self) -> NetworkCreateOptions

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 NetworkCreateOptions

Source§

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

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

impl<'de> Deserialize<'de> for NetworkCreateOptions

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 NetworkCreateOptions

Source§

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

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 Eq for NetworkCreateOptions

Source§

impl StructuralPartialEq for NetworkCreateOptions

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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