Struct bandsocks::RegistryClient

pub struct RegistryClient { /* fields omitted */ }

Registry clients can download and store data from an image registry

Each client includes settings like authentication, default server, and a cache storage location. One client can be used to download multiple images from multiple registries.

Implementations

impl RegistryClient

pub fn new() -> Result<RegistryClient, ImageError>

Construct a new registry client with default options

pub fn builder() -> RegistryClientBuilder

Construct a registry client with custom options, via ClientBuilder

pub fn default_user_agent() -> HeaderValue

Return the default User-Agent that we use if no other is set

pub fn default_cache_dir() -> Result<PathBuf, ImageError>

Determine a default per-user cache directory which will be used if an alternate cache directory is not specified.

Typically this returns $HOME/.cache/bandsocks, but it may return $XDG_CACHE_HOME/bandsocks if the per-user cache directory has been set, and the default cache location can be customized directly via the $BANDSOCKS_CACHE environment variable.

pub fn default_registry() -> DefaultRegistry

Return the default registry server

This is the server used when nothing else has been specified either in ImageName or RegistryClientBuilder.

pub async fn pull<'_, '_>(
    &'_ mut self,
    image: &'_ ImageName
) -> Result<Arc<Image>, ImageError>

Resolve an ImageName into an Image if possible

This will always try to load the image from local cache first without accessing the network. If the image is not already available in cache, it will be downloaded from the indicated registry server. If a content digest is given, it will be verified and the image is only returned if it matches the expected content.

The resulting image is mapped into memory and ready for use in any number of containers.

Trait Implementations

impl Clone for RegistryClient

pub fn clone(&self) -> RegistryClient

Returns a copy of the value.

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

Performs copy-assignment from source.