Struct docker_registry::v2::Client

pub struct Client { /* private fields */ }

A Client to make outgoing API requests to a registry.

Implementations

impl Client

pub fn get_catalog<'a, 'b: 'a>( &'b self, paginate: Option<u32>, ) -> impl Stream<Item = Result<String>> + 'a

impl Client

pub async fn authenticate(self, scopes: &[&str]) -> Result<Self>

Perform registry authentication and return the authenticated client.

If Bearer authentication is used the returned client will be authorized for the requested scopes.

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

Check whether the client can successfully make requests to the registry.

This could be due to granted anonymous access or valid credentials.

impl Client

pub async fn get_manifest( &self, name: &str, reference: &str, ) -> Result<Manifest>

Fetch an image manifest.

The name and reference parameters identify the image. The reference may be either a tag or digest.

pub async fn get_manifest_and_ref( &self, name: &str, reference: &str, ) -> Result<(Manifest, Option<String>)>

Fetch an image manifest and return it with its digest.

The name and reference parameters identify the image. The reference may be either a tag or digest.

pub async fn get_manifestref( &self, name: &str, reference: &str, ) -> Result<Option<String>>

Fetch content digest for a particular tag.

pub async fn has_manifest( &self, name: &str, reference: &str, mediatypes: Option<&[&str]>, ) -> Result<Option<MediaTypes>>

Check if an image manifest exists.

The name and reference parameters identify the image. The reference may be either a tag or digest.

impl Client

pub fn get_tags<'a, 'b: 'a, 'c: 'a>( &'b self, name: &'c str, paginate: Option<u32>, ) -> impl Stream<Item = Result<String>> + 'a

List existing tags for an image.

impl Client

pub async fn has_blob(&self, name: &str, digest: &str) -> Result<bool>

Check if a blob exists.

pub async fn get_blob_response( &self, name: &str, digest: &str, ) -> Result<BlobResponse>

pub async fn get_blob(&self, name: &str, digest: &str) -> Result<Vec<u8>>

Retrieve blob.

pub async fn get_blob_stream( &self, name: &str, digest: &str, ) -> Result<impl Stream<Item = Result<Vec<u8>>>>

Retrieve blob stream.

impl Client

pub fn configure() -> Config

pub async fn ensure_v2_registry(self) -> Result<Self>

Ensure remote registry supports v2 API.

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

Check whether remote registry supports v2 API.

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

Check whether remote registry supports v2 API and self is authorized. Authorized means to successfully GET the /v2 endpoint on the remote registry.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.