Struct HttpRegistry 

pub struct HttpRegistry<'gctx> {
    name: InternedString,
    registry_config: Mutex<Option<RegistryConfig>>,
    inner: HttpBackend<'gctx>,
}

A registry served by the HTTP-based registry API.

This type is primarily accessed through the RegistryData trait.

HttpRegistry implements the HTTP-based registry API outlined in RFC 2789. Read the RFC for the complete protocol, but roughly the implementation loads each index file (e.g., config.json or re/ge/regex) from an HTTP service rather than from a locally cloned git repository. The remote service can more or less be a static file server that simply serves the contents of the origin git repository.

Implemented naively, this leads to a significant amount of network traffic, as a lookup of any index file would need to check with the remote backend if the index file has changed. This cost is somewhat mitigated by the use of HTTP conditional fetches (If-Modified-Since and If-None-Match for ETags) which can be efficiently handled by HTTP/2.

Fields

name: InternedString

The name of this source, a unique string (across all sources) used as the directory name where its cached content is stored.

registry_config: Mutex<Option<RegistryConfig>>

Cached registry configuration.

inner: HttpBackend<'gctx>

Backend used for making network requests.

Implementations

impl<'gctx> HttpRegistry<'gctx>

pub fn new( source_id: SourceId, gctx: &'gctx GlobalContext, name: &str, ) -> CargoResult<HttpRegistry<'gctx>>

Creates a HTTP-rebased remote registry for source_id.

• name — Name of a path segment where .crate tarballs and the registry index are stored. Expect to be unique.

fn inner(&self) -> &HttpBackend<'gctx>

async fn config(&self) -> CargoResult<RegistryConfig>

Get the registry configuration from either cache or remote.

async fn config_opt(&self) -> CargoResult<Option<RegistryConfig>>

Get the registry configuration from either cache or remote. Returns None if the config is not available.

async fn config_opt_inner(&self) -> CargoResult<Option<RegistryConfig>>

fn config_from_filesystem(&self) -> Option<RegistryConfig>

Get the cached registry configuration from the filesystem, if it exists.

async fn sparse_fetch( &self, path: &str, index_version: Option<&str>, ) -> CargoResult<LoadResponse>

Trait Implementations

impl<'gctx> RegistryData for HttpRegistry<'gctx>

fn prepare(&self) -> CargoResult<()>

Performs initialization for the registry.

fn index_path(&self) -> &Filesystem

Returns the path to the index.

fn cache_path(&self) -> &Filesystem

Returns the path of the directory that stores the cache of .crate files.

fn assert_index_locked<'a>(&self, path: &'a Filesystem) -> &'a Path

Validates that the global package cache lock is held.

fn is_updated(&self) -> bool

Is the local cached data up-to-date?

fn load<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _root: &'life1 Path, path: &'life2 Path, index_version: Option<&'life3 str>, ) -> Pin<Box<dyn Future<Output = CargoResult<LoadResponse>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Loads the JSON for a specific named package from the index.

fn config<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = CargoResult<Option<RegistryConfig>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Loads the config.json file and returns it.

fn invalidate_cache(&self)

Invalidates locally cached data.

fn set_quiet(&mut self, quiet: bool)

If quiet, the source should not display any progress or status messages.

fn download(&self, pkg: PackageId, checksum: &str) -> CargoResult<MaybeLock>

Prepare to start downloading a .crate file.

fn finish_download( &self, pkg: PackageId, checksum: &str, data: &[u8], ) -> CargoResult<File>

Finish a download by saving a .crate file to disk.

fn is_crate_downloaded(&self, pkg: PackageId) -> bool

Returns whether or not the .crate file is already downloaded.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 616 bytes