Struct podman_api::api::Volume

source · [−]

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

Expand description

Interface for accessing and manipulating Podman Volume.

Api Reference

Implementations

source

impl<'podman> Volume<'podman>

source

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

Exports an interface exposing operations against a Volume instance.

source

pub fn name(&self) -> &Id

A getter for Volume name

source

impl<'podman> Volume<'podman>

source

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

Api Reference

Quick way to determine if this volume exists.

Examples:

async {
    use podman_api::Podman;
    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),
    }
};

source

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

Api Reference

Obtain low-level information about this volume.

Examples:

async {
    use podman_api::Podman;
    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),
    }
};

source

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

Api Reference

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

Examples:

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

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

source

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

Api Reference

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

Examples:

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

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