Struct docker_api::network::Network

pub struct Network<'docker> { /* fields omitted */ }

Interface for accessing and manipulating a docker network

Implementations

impl<'docker> Network<'docker>

pub fn new<S>(docker: &'docker Docker, id: S) -> Self where
    S: Into<String>, 

Exports an interface exposing operations against a network instance

pub fn id(&self) -> &str

a getter for the Network id

pub async fn inspect(&self) -> Result<NetworkDetails>

Inspects the current docker network instance’s details

API Reference: https://docs.docker.com/engine/api/v1.41/#operation/NetworkInspect

pub async fn delete(&self) -> Result<()>

Delete the network instance

API Reference: https://docs.docker.com/engine/api/v1.41/#operation/NetworkDelete

pub async fn connect(&self, opts: &ContainerConnectionOptions) -> Result<()>

Connect container to network

API Reference: https://docs.docker.com/engine/api/v1.41/#operation/NetworkConnect

pub async fn disconnect(&self, opts: &ContainerConnectionOptions) -> Result<()>

Disconnect container to network

API Reference: https://docs.docker.com/engine/api/v1.41/#operation/NetworkDisconnect

Trait Implementations

impl<'docker> Debug for Network<'docker>

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

Formats the value using the given formatter.