Struct Client

pub struct Client<R, C, N>
where
    R: RegistryStorage,
    C: ContentStorage,
    N: NamespaceMapStorage,
{ /* private fields */ }

A client for a Warg registry.

Implementations

impl<R: RegistryStorage, C: ContentStorage, N: NamespaceMapStorage> Client<R, C, N>

pub fn new( url: impl IntoUrl, registry: R, content: C, namespace_map: N, auth_token: Option<Secret<String>>, ignore_federation_hints: bool, disable_auto_accept_federation_hints: bool, disable_auto_package_init: bool, disable_interactive: bool, keyring_backend: Option<String>, keys: IndexSet<String>, ) -> ClientResult<Self>

Creates a new client for the given URL, registry storage, and content storage.

pub fn url(&self) -> &RegistryUrl

Gets the URL of the client.

pub fn registry(&self) -> &R

Gets the registry storage used by the client.

pub fn content(&self) -> &C

Gets the content storage used by the client.

pub fn namespace_map(&self) -> &N

Gets the namespace map

pub async fn get_warg_registry( &self, namespace: &str, ) -> Result<Option<RegistryDomain>, ClientError>

Get warg registry domain.

pub async fn store_namespace( &self, namespace: String, registry_domain: RegistryDomain, ) -> Result<()>

Stores namespace mapping in local storage

pub async fn reset_namespaces(&self) -> Result<()>

Resets the namespace map

pub async fn reset_registry(&self) -> ClientResult<()>

Reset client storage for the registry.

pub async fn clear_content_cache(&self) -> ClientResult<()>

Clear client content cache.

pub async fn lock_component(&self, info: &PackageInfo) -> ClientResult<Vec<u8>>

Locks component

pub async fn bundle_component( &self, info: &PackageInfo, ) -> ClientResult<Vec<u8>>

Bundles component

pub async fn publish(&self, signing_key: &PrivateKey) -> ClientResult<RecordId>

Submits the publish information in client storage.

If there’s no publishing information in client storage, an error is returned.

Returns the identifier of the record that was published.

Use wait_for_publish to wait for the record to transition to the published state.

pub async fn sign_with_keyring_and_publish( &self, publish_info: Option<PublishInfo>, ) -> ClientResult<RecordId>

Submits the provided publish information or, if not provided, loads from client storage. Uses the keyring to retrieve a key and sign.

If there’s no publishing information in client storage, an error is returned.

Returns the identifier of the record that was published.

Use wait_for_publish to wait for the record to transition to the published state.

pub async fn publish_with_info( &self, signing_key: &PrivateKey, publish_info: PublishInfo, ) -> ClientResult<RecordId>

Submits the provided publish information.

Any publish information in client storage is ignored.

Returns the identifier of the record that was published.

Use wait_for_publish to wait for the record to transition to the published state.

pub async fn wait_for_publish( &self, package: &PackageName, record_id: &RecordId, interval: Duration, ) -> ClientResult<()>

Waits for a package record to transition to the published state.

The interval is the amount of time to wait between checks.

Returns an error if the package record was rejected.

pub async fn update(&self) -> ClientResult<()>

Updates all package logs in client registry storage to the latest registry checkpoint.

pub async fn download( &self, package: &PackageName, requirement: &VersionReq, ) -> Result<Option<PackageDownload>, ClientError>

Downloads the latest version of a package into client storage that satisfies the given version requirement.

If the requested package log is not present in client storage, it will be fetched from the registry first.

An error is returned if the package does not exist.

If a version satisfying the requirement does not exist, None is returned.

Returns the path within client storage of the package contents for the resolved version.

pub async fn download_as_stream( &self, package: &PackageName, requirement: &VersionReq, ) -> Result<Option<(PackageDownloadInfo, impl Stream<Item = Result<Bytes>>)>, ClientError>

Downloads the latest version of a package.

If the requested package log is not present in client storage, it will be fetched from the registry first.

An error is returned if the package does not exist.

If a version satisfying the requirement does not exist, None is returned.

pub async fn download_exact( &self, package: &PackageName, version: &Version, ) -> Result<PackageDownload, ClientError>

Downloads the specified version of a package into client storage.

If the requested package log is not present in client storage, it will be fetched from the registry first.

An error is returned if the package or version does not exist.

Returns the path within client storage of the package contents for the specified version.

pub async fn download_exact_as_stream( &self, package: &PackageName, version: &Version, ) -> Result<(PackageDownloadInfo, impl Stream<Item = Result<Bytes>>), ClientError>

Downloads the specified version of a package.

If the requested package log is not present in client storage, it will be fetched from the registry first.

An error is returned if the package or version does not exist.

pub async fn fetch_packages( &self, names: impl IntoIterator<Item = &PackageName>, ) -> Result<Vec<PackageInfo>, ClientError>

Fetches package logs without checking local storage first.

pub async fn fetch_package( &self, name: &PackageName, ) -> Result<PackageInfo, ClientError>

Fetches the PackageInfo without checking local storage first.

pub async fn package( &self, name: &PackageName, ) -> Result<PackageInfo, ClientError>

Retrieves the PackageInfo from local storage, if present, otherwise fetches from the registry.

impl Client<FileSystemRegistryStorage, FileSystemContentStorage, FileSystemNamespaceMapStorage>

pub async fn try_new_with_config( registry: Option<&str>, config: &Config, auth_token: Option<Secret<String>>, ) -> Result<StorageLockResult<Self>, ClientError>

Attempts to create a client for the given registry URL.

If the URL is None, the home registry URL is used; if there is no home registry URL, an error is returned.

If a lock cannot be acquired for a storage directory, then NewClientResult::Blocked is returned with the path to the directory that could not be locked.

pub async fn try_new_with_default_config( url: Option<&str>, ) -> Result<StorageLockResult<Self>, ClientError>

Attempts to create a client for the given registry URL.

If the URL is None, the home registry URL is used; if there is no home registry URL, an error is returned.

If a lock cannot be acquired for a storage directory, then NewClientResult::Blocked is returned with the path to the directory that could not be locked.

Same as calling try_new_with_config with Config::from_default_file()?.unwrap_or_default().

pub async fn new_with_config( registry: Option<&str>, config: &Config, auth_token: Option<Secret<String>>, ) -> Result<Self, ClientError>

Creates a client for the given registry URL.

If the URL is None, the home registry URL is used; if there is no home registry URL, an error is returned.

This method blocks if storage locks cannot be acquired.

pub async fn new_with_default_config( url: Option<&str>, ) -> Result<Self, ClientError>

Creates a client for the given registry URL.

If the URL is None, the home registry URL is used; if there is no home registry URL, an error is returned.

This method blocks if storage locks cannot be acquired.

Same as calling new_with_config with Config::from_default_file()?.unwrap_or_default().