Struct podman_api::api::Networks

pub struct Networks<'podman> { /* private fields */ }

Handle for Podman Networks.

Implementations

impl<'podman> Networks<'podman>

pub fn new(podman: &'podman Podman) -> Self

Exports an interface for interacting with Podman Networks.

pub fn get(&self, name: impl Into<Id>) -> Network<'podman>

Returns a reference to a set of operations available to a specific Network.

impl<'podman> Networks<'podman>

pub async fn create(
    &self,
    opts: &NetworkCreateOpts
) -> Result<NetworkCreateReport>

Api Reference

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

Examples:

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

    match podman
        .networks()
        .create(&NetworkCreateOpts::builder().name("test-network").build())
        .await
    {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn list(
    &self,
    opts: &NetworkListOpts
) -> Result<Vec<NetworkListReport>>

Api Reference

List network configurations.

Examples:

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

    match podman.networks().list(&Default::default()).await {
        Ok(networks) => println!("{:?}", networks),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn prune(
    &self,
    opts: &NetworkPruneOpts
) -> Result<Vec<NetworkPruneReport>>

Api Reference

Delete unused networks.

Examples:

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

    match podman.networks().prune(&Default::default()).await {
        Ok(report) => println!("{:?}", report),
        Err(e) => eprintln!("{}", e),
    }
};

Trait Implementations

impl<'podman> Debug for Networks<'podman>

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

Formats the value using the given formatter.