Struct Client 

pub struct Client {
    pub cache: Cache,
    pub opts: ClientOpts,
    /* private fields */
}

Client for interacting with an OCI registry for Spin applications.

Fields

cache: Cache

Global cache for the metadata, Wasm modules, and static assets pulled from OCI registries.

opts: ClientOpts

Client options

Implementations

impl Client

pub async fn new(insecure: bool, cache_root: Option<PathBuf>) -> Result<Self>

Create a new instance of an OCI client for distributing Spin applications.

pub async fn push( &mut self, manifest_path: &Path, profile: Option<&str>, reference: impl AsRef<str>, annotations: Option<BTreeMap<String, String>>, infer_annotations: InferPredefinedAnnotations, compose_mode: ComposeMode, ) -> Result<Option<String>>

Push a Spin application to an OCI registry and return the digest (or None if the digest cannot be determined).

pub async fn push_locked( &mut self, locked: LockedApp, reference: impl AsRef<str>, annotations: Option<BTreeMap<String, String>>, infer_annotations: InferPredefinedAnnotations, compose_mode: ComposeMode, ) -> Result<Option<String>>

Push a Spin application to an OCI registry and return the digest (or None if the digest cannot be determined).

pub async fn pull(&mut self, reference: &str) -> Result<OciImageManifest>

Pull a Spin application from an OCI registry.

pub async fn pull_with_digest( &mut self, reference: &str, ) -> Result<(OciImageManifest, String)>

Pull a Spin application from an OCI registry, returning the manifest and the manifest digest the reference resolved to.

The manifest and locked application are cached under that digest (see Client::lockfile_path), so pulls of different artifacts from the same repository never overwrite each other’s cached locked application.

pub async fn lockfile_path(&self, reference: impl AsRef<str>) -> Result<PathBuf>

Get the file path to the cached locked app configuration given a reference.

A reference that includes a digest maps to a location keyed by that digest. A reference without one maps to a location keyed by its tag (or latest), which a later pull of the same tag overwrites even if the tag then names a different artifact. To read the locked app of a specific pull, pass a reference pinned to the digest returned by Client::pull_with_digest.

pub async fn login( server: impl AsRef<str>, username: impl AsRef<str>, password: impl AsRef<str>, ) -> Result<()>

Save a credential set containing the registry username and password.

pub async fn insert_token( &mut self, reference: &Reference, op: RegistryOperation, token: RegistryTokenType, )

Insert a token in the OCI client token cache.