Struct oci_registry_client::DockerRegistryClientV2

pub struct DockerRegistryClientV2 { /* fields omitted */ }

Client to fetch image manifests and download blobs.

DockerRegistryClientV2 provides functions to fetch manifests and download blobs from a OCI Image Registry (or a Docker Registry API V2).

Methods

impl DockerRegistryClientV2

pub fn new<T: Into<String>>(service: T, api_url: T, oauth_url: T) -> Self

Returns a new DockerRegistryClientV2.

Arguments

• service - Name of a Image Registry Service (example: registry.docker.io)
• api_url - Service HTTPS address (example: https://registry-1.docker.io)
• auth_url - Address to get a OAuth 2.0 token for this service.

Example

let mut client = DockerRegistryClientV2::new(
    "registry.docker.io",
    "https://registry-1.docker.io",
    "https://auth.docker.io/token"
);

pub fn set_auth_token(&mut self, token: Option<AuthToken>)

Set access token to authenticate subsequent requests.

pub async fn auth<'_, '_, '_, '_>(
    &'_ self,
    r#type: &'_ str,
    name: &'_ str,
    action: &'_ str
) -> Result<AuthToken, ErrorResponse>

Fetch a access token from auth_url for this service.

Arguments

• type - Scope type (example: "repository").
• name - Name of resource (example: "library/ubuntu").
• action - List of actions separated by comma (example: "pull").

pub async fn version<'_>(&'_ self) -> Result<Version, ErrorResponse>

Get API version.

pub async fn list_manifests<'_, '_, '_>(
    &'_ self,
    image: &'_ str,
    reference: &'_ str
) -> Result<ManifestList, ErrorResponse>

List manifests from given image and reference.

pub async fn manifest<'_, '_, '_>(
    &'_ self,
    image: &'_ str,
    reference: &'_ str
) -> Result<Manifest, ErrorResponse>

Get the image manifest.

pub async fn config<'_, '_, '_>(
    &'_ self,
    image: &'_ str,
    reference: &'_ Digest
) -> Result<Image, ErrorResponse>

Get the container config.

pub async fn blob<'_, '_, '_>(
    &'_ self,
    image: &'_ str,
    digest: &'_ Digest
) -> Result<Blob, ErrorResponse>

Retrieve the blob from the registry identified by digest.

Trait Implementations

impl Clone for DockerRegistryClientV2

fn clone(&self) -> DockerRegistryClientV2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DockerRegistryClientV2

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

Formats the value using the given formatter.