Struct ImageProxy

pub struct ImageProxy { /* private fields */ }

Manage a child process proxy to fetch container images.

Implementations

impl ImageProxy

pub async fn new() -> Result<Self>

Create an image proxy that fetches the target image, using default configuration.

pub async fn new_with_config(config: ImageProxyConfig) -> Result<Self>

Create an image proxy that fetches the target image

pub async fn open_image(&self, imgref: &str) -> Result<OpenedImage>

pub async fn open_image_optional( &self, imgref: &str, ) -> Result<Option<OpenedImage>>

pub async fn close_image(&self, img: &OpenedImage) -> Result<()>

pub async fn fetch_manifest_raw_oci( &self, img: &OpenedImage, ) -> Result<(String, Vec<u8>)>

Fetch the manifest as raw bytes, converted to OCI if necessary. The original digest of the unconverted manifest is also returned. For more information on OCI manifests, see https://github.com/opencontainers/image-spec/blob/main/manifest.md

pub async fn fetch_manifest( &self, img: &OpenedImage, ) -> Result<(String, ImageManifest)>

Fetch the manifest. For more information on OCI manifests, see https://github.com/opencontainers/image-spec/blob/main/manifest.md

pub async fn fetch_config_raw(&self, img: &OpenedImage) -> Result<Vec<u8>>

Fetch the config. For more information on OCI config, see https://github.com/opencontainers/image-spec/blob/main/config.md

pub async fn fetch_config( &self, img: &OpenedImage, ) -> Result<ImageConfiguration>

Fetch the config. For more information on OCI config, see https://github.com/opencontainers/image-spec/blob/main/config.md

pub async fn get_blob( &self, img: &OpenedImage, digest: &Digest, size: u64, ) -> Result<(impl AsyncBufRead + Send + Unpin, impl Future<Output = Result<()>> + Unpin + '_)>

Fetch a blob identified by e.g. sha256:<digest>. https://github.com/opencontainers/image-spec/blob/main/descriptor.md

The requested size and digest are verified (by the proxy process).

Note that because of the implementation details of this function, you should [futures::join!] the returned futures instead of polling one after the other. The secondary “driver” future will only return once everything has been read from the reader future.

pub async fn get_raw_blob( &self, img: &OpenedImage, digest: &Digest, ) -> Result<(u64, File, impl Future<Output = Result<(), GetBlobError>> + Unpin + '_)>

Fetch a blob identified by e.g. sha256:<digest>; does not perform any verification that the blob matches the digest. The size of the blob and a pipe file descriptor are returned.

pub async fn get_descriptor( &self, img: &OpenedImage, descriptor: &Descriptor, ) -> Result<(impl AsyncBufRead + Send + Unpin, impl Future<Output = Result<()>> + Unpin + '_)>

Fetch a descriptor. The requested size and digest are verified (by the proxy process).

pub async fn get_layer_info( &self, img: &OpenedImage, ) -> Result<Option<Vec<ConvertedLayerInfo>>>

Returns data that can be used to find the “diffid” corresponding to a particular layer.

pub async fn finalize(self) -> Result<()>

Close the connection and wait for the child process to exit successfully.

Trait Implementations

impl Debug for ImageProxy

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

Formats the value using the given formatter.