Trait Images

pub trait Images:
    HasConfig
    + Send
    + Sync {
    // Provided methods
    fn image_build_libpod<'a>(
        &'a self,
        params: Option<ImageBuildLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<ImageBuildLibpod200, Error>> + Send + 'a>> { ... }
    fn image_delete_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageDeleteLibpod>,
    ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>> { ... }
    fn image_changes_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageChangesLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>> { ... }
    fn image_exists_libpod<'a>(
        &'a self,
        name: &'a str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> { ... }
    fn image_get_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageGetLibpod<'a>>,
    ) -> Pin<Box<dyn Stream<Item = Result<Bytes, Error>> + Send + 'a>> { ... }
    fn image_history_libpod<'a>(
        &'a self,
        name: &'a str,
    ) -> Pin<Box<dyn Future<Output = Result<HistoryResponse, Error>> + Send + 'a>> { ... }
    fn image_inspect_libpod<'a>(
        &'a self,
        name: &'a str,
    ) -> Pin<Box<dyn Future<Output = Result<ImageData, Error>> + Send + 'a>> { ... }
    fn image_push_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImagePushLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>> { ... }
    fn image_resolve_libpod<'a>(
        &'a self,
        name: &'a str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> { ... }
    fn image_tag_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageTagLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> { ... }
    fn image_tree_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageTreeLibpod>,
    ) -> Pin<Box<dyn Future<Output = Result<ImageTreeReport, Error>> + Send + 'a>> { ... }
    fn image_untag_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageUntagLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> { ... }
    fn image_export_libpod<'a>(
        &'a self,
        params: Option<ImageExportLibpod<'a>>,
    ) -> Pin<Box<dyn Stream<Item = Result<Bytes, Error>> + Send + 'a>> { ... }
    fn image_import_libpod<'a>(
        &'a self,
        params: Option<ImageImportLibpod<'a>>,
        upload: String,
    ) -> Pin<Box<dyn Future<Output = Result<ImageImportReport, Error>> + Send + 'a>> { ... }
    fn image_list_libpod<'a>(
        &'a self,
        params: Option<ImageListLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<LibpodImageSummary>, Error>> + Send + 'a>> { ... }
    fn image_load_libpod<'a>(
        &'a self,
        upload: String,
    ) -> Pin<Box<dyn Future<Output = Result<ImageLoadReport, Error>> + Send + 'a>> { ... }
    fn image_prune_libpod<'a>(
        &'a self,
        params: Option<ImagePruneLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<PruneReport>, Error>> + Send + 'a>> { ... }
    fn image_pull_libpod<'a>(
        &'a self,
        params: Option<ImagePullLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesPullReport, Error>> + Send + 'a>> { ... }
    fn image_delete_all_libpod<'a>(
        &'a self,
        params: Option<ImageDeleteAllLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>> { ... }
    fn image_scp_libpod<'a>(
        &'a self,
        name: &'a str,
        params: Option<ImageScpLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<ScpReport, Error>> + Send + 'a>> { ... }
    fn image_search_libpod<'a>(
        &'a self,
        params: Option<ImageSearchLibpod<'a>>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<RegistrySearchResponse>, Error>> + Send + 'a>> { ... }
}

Available on crate feature v5 only.

Provided Methods

fn image_build_libpod<'a>( &'a self, params: Option<ImageBuildLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ImageBuildLibpod200, Error>> + Send + 'a>>

POST /libpod/build

Create image

Build an image from the given Dockerfile(s)

fn image_delete_libpod<'a>( &'a self, name: &'a str, params: Option<ImageDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>>

DELETE /libpod/images/{name}

Remove an image from the local storage.

fn image_changes_libpod<'a>( &'a self, name: &'a str, params: Option<ImageChangesLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /libpod/images/{name}/changes

Report on changes to images’s filesystem; adds, deletes or modifications.

Returns which files in an image’s filesystem have been added, deleted, or modified. The Kind of modification can be one of:

0: Modified 1: Added 2: Deleted

fn image_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/images/{name}/exists

Image exists

Check if image exists in local store

fn image_get_libpod<'a>( &'a self, name: &'a str, params: Option<ImageGetLibpod<'a>>, ) -> Pin<Box<dyn Stream<Item = Result<Bytes, Error>> + Send + 'a>>

GET /libpod/images/{name}/get

Export an image

fn image_history_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<HistoryResponse, Error>> + Send + 'a>>

GET /libpod/images/{name}/history

History of an image

Return parent layers of an image.

fn image_inspect_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<ImageData, Error>> + Send + 'a>>

GET /libpod/images/{name}/json

Inspect an image

Obtain low-level information about an image

fn image_push_libpod<'a>( &'a self, name: &'a str, params: Option<ImagePushLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

POST /libpod/images/{name}/push

Push Image

Push an image to a container registry

fn image_resolve_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/images/{name}/resolve

Resolve an image (short) name

Resolve the passed image name to a list of fully-qualified images referring to container registries.

fn image_tag_libpod<'a>( &'a self, name: &'a str, params: Option<ImageTagLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/images/{name}/tag

Tag an image

Tag an image so that it becomes part of a repository.

fn image_tree_libpod<'a>( &'a self, name: &'a str, params: Option<ImageTreeLibpod>, ) -> Pin<Box<dyn Future<Output = Result<ImageTreeReport, Error>> + Send + 'a>>

GET /libpod/images/{name}/tree

Image tree

Retrieve the image tree for the provided image name or ID

fn image_untag_libpod<'a>( &'a self, name: &'a str, params: Option<ImageUntagLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/images/{name}/untag

Untag an image

Untag an image. If not repo and tag are specified, all tags are removed from the image.

fn image_export_libpod<'a>( &'a self, params: Option<ImageExportLibpod<'a>>, ) -> Pin<Box<dyn Stream<Item = Result<Bytes, Error>> + Send + 'a>>

GET /libpod/images/export

Export multiple images

Export multiple images into a single object. Only docker-archive is currently supported.

fn image_import_libpod<'a>( &'a self, params: Option<ImageImportLibpod<'a>>, upload: String, ) -> Pin<Box<dyn Future<Output = Result<ImageImportReport, Error>> + Send + 'a>>

POST /libpod/images/import

Import image

Import a previously exported tarball as an image.

fn image_list_libpod<'a>( &'a self, params: Option<ImageListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<LibpodImageSummary>, Error>> + Send + 'a>>

GET /libpod/images/json

List Images

Returns a list of images on the server

fn image_load_libpod<'a>( &'a self, upload: String, ) -> Pin<Box<dyn Future<Output = Result<ImageLoadReport, Error>> + Send + 'a>>

POST /libpod/images/load

Load image

Load an image (oci-archive or docker-archive) stream.

fn image_prune_libpod<'a>( &'a self, params: Option<ImagePruneLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PruneReport>, Error>> + Send + 'a>>

POST /libpod/images/prune

Prune unused images

Remove images that are not being used by a container

fn image_pull_libpod<'a>( &'a self, params: Option<ImagePullLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesPullReport, Error>> + Send + 'a>>

POST /libpod/images/pull

Pull images

Pull one or more images from a container registry.

fn image_delete_all_libpod<'a>( &'a self, params: Option<ImageDeleteAllLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>>

DELETE /libpod/images/remove

Remove one or more images from the storage.

fn image_scp_libpod<'a>( &'a self, name: &'a str, params: Option<ImageScpLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ScpReport, Error>> + Send + 'a>>

POST /libpod/images/scp/{name}

Copy an image from one host to another

fn image_search_libpod<'a>( &'a self, params: Option<ImageSearchLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<RegistrySearchResponse>, Error>> + Send + 'a>>

GET /libpod/images/search

Search images

Search registries for images

Implementors

impl Images for PodmanRestClient