Struct LocalRegistry

pub struct LocalRegistry { /* private fields */ }

Available on crate feature local only.

A local registry implementation

Implementations

impl LocalRegistry

pub fn open(path: PathBuf, validate: bool) -> Result<Self, Error>

Opens an existing local registry, optionally validating it

pub fn validate(path: &Path) -> Result<(), Error>

Validates the specified path contains a local registry

Validation ensures every crate file matches the expected according to the index entry for the crate

pub fn cached_krate( &self, name: KrateName<'_>, _lock: &FileLock, ) -> Result<Option<IndexKrate>, Error>

Gets the index information for the crate

Note this naming is just to be consistent with crate::SparseIndex and crate::GitIndex, local registries do not have a .cache in the index

pub fn krate_path(&self, name: KrateName<'_>) -> PathBuf

Gets the path to the index entry for the krate.

Note that unlike .cache entries for git and sparse indices, these are not binary files, they are just the JSON line format

Trait Implementations

impl From<LocalRegistry> for ComboIndex

Available on crate features __git and sparse only.

fn from(local: LocalRegistry) -> Self

Converts to this type from the input type.