# Struct cargo::sources::registry::http_remote::HttpRegistry

source ·

    pub struct HttpRegistry<'cfg> {Show 15 fields
        index_path: Filesystem,
        cache_path: Filesystem,
        source_id: SourceId,
        config: &'cfg Config,
        url: Url,
        multi: Multi,
        requested_update: bool,
        downloads: Downloads<'cfg>,
        multiplexing: bool,
        fresh: HashSet<PathBuf>,
        fetch_started: bool,
        registry_config: Option<RegistryConfig>,
        auth_required: bool,
        login_url: Option<Url>,
        quiet: bool,
    }

Expand description

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 `ETag`s) which can be efficiently handled by HTTP/2.

## Fields§

§`index_path: Filesystem`§`cache_path: Filesystem`§`source_id: SourceId`§`config: &'cfg Config`§`url: Url`

Store the server URL without the protocol prefix (sparse+)

§`multi: Multi`

HTTP multi-handle for asynchronous/parallel requests.

§`requested_update: bool`

Has the client requested a cache update?

Only if they have do we double-check the freshness of each locally-stored index file.

§`downloads: Downloads<'cfg>`

State for currently pending index downloads.

§`multiplexing: bool`

Does the config say that we can use HTTP multiplexing?

§`fresh: HashSet<PathBuf>`

What paths have we already fetched since the last index update?

We do not need to double-check any of these index files since we have already done so.

§`fetch_started: bool`

Have we started to download any index files?

§`registry_config: Option<RegistryConfig>`

Cached registry configuration.

§`auth_required: bool`

Should we include the authorization header?

§`login_url: Option<Url>`

Url to get a token for the registry.

§`quiet: bool`

Disables status messages.

## Implementations§

source§

### impl<'cfg> HttpRegistry<'cfg>

source

#### pub fn new( source_id: SourceId, config: &'cfg Config, name: &str ) -> CargoResult<HttpRegistry<'cfg>>

source

#### fn handle_http_header(buf: &[u8]) -> Option<(&str, &str)>

source

#### fn start_fetch(&mut self) -> CargoResult<()>

source

#### fn handle_completed_downloads(&mut self) -> CargoResult<()>

source

#### fn full_url(&self, path: &Path) -> String

source

#### fn is_fresh(&self, path: &Path) -> bool

source

#### fn config_cached(&mut self) -> CargoResult<Option<&RegistryConfig>>

Get the cached registry configuration, if it exists.

source

#### fn config(&mut self) -> Poll<CargoResult<&RegistryConfig>>

Get the registry configuration.

source

#### fn add_sleepers(&mut self) -> CargoResult<()>

## Trait Implementations§

source§

### impl<'cfg> RegistryData for HttpRegistry<'cfg>

source§

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

Performs initialization for the registry. Read more
source§

#### fn index_path(&self) -> &Filesystem

Returns the path to the index. Read more
source§

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

Validates that the global package cache lock is held. Read more
source§

#### fn is_updated(&self) -> bool

Is the local cached data up-to-date?
source§

#### fn load( &mut self, _root: &Path, path: &Path, index_version: Option<&str> ) -> Poll<CargoResult<LoadResponse>>

Loads the JSON for a specific named package from the index. Read more
source§

#### fn config(&mut self) -> Poll<CargoResult<Option<RegistryConfig>>>

Loads the `config.json` file and returns it. Read more
source§

#### fn invalidate_cache(&mut self)

Invalidates locally cached data.
source§

#### fn set_quiet(&mut self, quiet: bool)

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

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

Prepare to start downloading a `.crate` file. Read more
source§

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

Finish a download by saving a `.crate` file to disk. Read more
source§

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

Returns whether or not the `.crate` file is already downloaded.
source§

#### fn block_until_ready(&mut self) -> CargoResult<()>

Block until all outstanding Poll::Pending requests are Poll::Ready.

## Auto Trait Implementations§

§

### impl<'cfg> !RefUnwindSafe for HttpRegistry<'cfg>

§

### impl<'cfg> !Send for HttpRegistry<'cfg>

§

### impl<'cfg> !Sync for HttpRegistry<'cfg>

§

### impl<'cfg> Unpin for HttpRegistry<'cfg>

§

### impl<'cfg> !UnwindSafe for HttpRegistry<'cfg>

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

const: unstable · source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> Same<T> for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

#### fn vzip(self) -> V

## 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: 696 bytes