Struct podman_api::api::Network

pub struct Network { /* private fields */ }

Interface for accessing and manipulating Podman Network.

Api Reference

Implementations

impl Network

pub fn new(podman: Podman, name: impl Into<Id>) -> Self

Exports an interface exposing operations against a Network instance.

pub fn name(&self) -> &Id

A getter for Network name

impl Network

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

Api Reference

Delete this container. To delete this network forcefully use Network::remove.

Examples:

async {
    use podman_api::Podman;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman.networks().get("some-network").delete().await {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn remove(&self) -> Result<Vec<NetworkRmReport>>

Api Reference

Force remove this network removing associated containers. To delete network normally use Network::delete.

Examples:

async {
    use podman_api::Podman;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman.networks().get("some-network").remove().await {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn exists(&self) -> Result<bool>

Api Reference

Quick way to determine if a network exists by name or id.

Examples:

async {
    use podman_api::Podman;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman.networks().get("some-network").exists().await {
        Ok(exists) => if exists {
            println!("network exists!");
        } else {
            println!("network doesn't exists!");
        },
        Err(e) => eprintln!("check failed: {}", e),
    }
};

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

Api Reference

Display low level configuration for this CNI network.

Examples:

async {
    use podman_api::Podman;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman.networks().get("some-network").inspect().await {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn disconnect_container(
    &self,
    opts: &NetworkDisconnectOpts
) -> Result<()>

Api Reference

Disconnect a container from this network.

Examples:

async {
    use podman_api::Podman;
    use podman_api::opts::NetworkDisconnectOpts;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman
        .networks()
        .get("some-network")
        .disconnect_container(
            &NetworkDisconnectOpts::builder()
                .container("containerid")
                .force(true)
                .build()
        )
        .await {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn connect_container(&self, opts: &NetworkConnectOpts) -> Result<()>

Api Reference

Connect a container to this network.

Examples:

async {
    use podman_api::Podman;
    use podman_api::opts::NetworkConnectOpts;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman
        .networks()
        .get("some-network")
        .connect_container(
            &NetworkConnectOpts::builder()
                .container("containerid")
                .interface_name("eno128")
                .build()
        )
        .await {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

Trait Implementations

impl Debug for Network

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

Formats the value using the given formatter.