Struct podman_api::api::Volumes

source · [−]

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

Expand description

Handle for Podman Volumes.

Implementations

source

impl<'podman> Volumes<'podman>

source

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

Exports an interface for interacting with Podman Volumes.

source

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

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

source

impl<'podman> Volumes<'podman>

source

pub async fn create(
&self,
opts: &VolumeCreateOpts
) -> Result<LibpodContainerInspectResponse>

Api Reference

Create a volume with specified options.

Examples:

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

    match podman
        .volumes()
        .create(
            &VolumeCreateOpts::builder()
                .driver("my-driver")
                .name("my-vol")
                .build(),
        )
        .await
    {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

source

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

Api Reference

Returns a list of volumes.

Examples:

async {
    use podman_api::Podman;
    use podman_api::opts::{VolumeListOpts, VolumeListFilter};

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

    for volume in podman
        .volumes()
        .list(
            &VolumeListOpts::builder()
                .filter([VolumeListFilter::Driver("my-sd".into())])
                .build(),
        )
        .await
        .unwrap()
    {
        println!("{:?}", volume);
    }
};

source

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

Api Reference

Delete unused volumes.

Examples:

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

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