Struct cargo::sources::registry::local::LocalRegistry

pub struct LocalRegistry<'cfg> {
    index_path: Filesystem,
    root: Filesystem,
    src_path: Filesystem,
    config: &'cfg Config,
    updated: bool,
    quiet: bool,
}

A local registry is a registry that lives on the filesystem as a set of .crate files with an index directory in the same format as a remote registry.

This type is primarily accessed through the RegistryData trait.

When a local registry is requested for a package, it simply looks into what its index has under the index directory. When LocalRegistry::download is called, a local registry verifies the checksum of the requested .crate tarball and then unpacks it to $CARGO_HOME/.registry/src.

Note that there is a third-party subcommand cargo-local-registry, which happened to be developed by a former Cargo team member when local registry was introduced. The tool is to ease the burden of maintaining local registries. However, in general the Cargo team avoids recommending any specific third-party crate. Just FYI.

Filesystem hierarchy

Here is an example layout of a local registry on a local filesystem:

[registry root]/
├── index/                      # registry index
│  ├── an/
│  │  └── yh/
│  │     └── anyhow
│  ├── ru/
│  │  └── st/
│  │     ├── rustls
│  │     └── rustls-ffi
│  └── se/
│     └── mv/
│        └── semver
├── anyhow-1.0.71.crate         # pre-downloaded crate tarballs
├── rustls-0.20.8.crate
├── rustls-ffi-0.8.2.crate
└── semver-1.0.17.crate

For general concepts of registries, see the module-level documentation.

Fields

index_path: Filesystem

Path to the registry index.

root: Filesystem

Root path of this local registry.

src_path: Filesystem

Path where this local registry extract .crate tarballs to.

config: &'cfg Config

updated: bool

Whether this source has updated all package information it may contain.

quiet: bool

Disables status messages.

Implementations

impl<'cfg> LocalRegistry<'cfg>

pub fn new(root: &Path, config: &'cfg Config, name: &str) -> LocalRegistry<'cfg>

Creates a local registry at root.

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

Trait Implementations

impl<'cfg> RegistryData for LocalRegistry<'cfg>

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

Performs initialization for the registry.

fn index_path(&self) -> &Filesystem

Returns the path to the index.

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

Validates that the global package cache lock is held.

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.

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

Loads the config.json file and returns it.

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

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

fn invalidate_cache(&mut 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 is_updated(&self) -> bool

Is the local cached data up-to-date?

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

Prepare to start downloading a .crate file.

fn finish_download( &mut 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: 88 bytes