Struct podman_api::api::Volume

pub struct Volume<'podman> { /* fields omitted */ }

Interface for accessing and manipulating Podman Volume.

Api Reference

Implementations

impl<'podman> Volume<'podman>

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

Exports an interface exposing operations against a Volume instance.

pub fn name(&self) -> &Id

A getter for Volume name

impl<'podman> Volume<'podman>

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

Api Reference

Quick way to determine if this volume exists.

Examples:

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

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

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

Api Reference

Obtain low-level information about this volume.

Examples:

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

match podman.volumes().get("my-vol").inspect().await {
    Ok(info) => println!("{:?}", info),
    Err(e) => eprintln!("{}", e),
}

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

Api Reference

Delete this volume. To forcefully remove an volume use Volume::remove.

Examples:

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

if let Err(e) = podman.volumes().get("my-vol").delete().await
    eprintln!("{}", e);
}

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

Api Reference

Remove this volume forcefully. To remove the volume normally use Volume::delete.

Examples:

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

if let Err(e) = podman.volumes().get("my-vol").remove().await
    eprintln!("{}", e);
}

Trait Implementations

impl<'podman> Debug for Volume<'podman>

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

Formats the value using the given formatter.