Struct crates_index::Index

[+] Show declaration

pub struct Index { /* fields omitted */ }

[−] Expand description

Wrapper around managing the crates.io-index git repository

Implementations

impl Index[−]

pub fn new<P: Into<PathBuf>>(path: P) -> Index[−]

Construct a new Index supplying a path where the index lives or should live

pub fn new_cargo_default() -> Index[−]

Use Cargo’s own index in CARGO_HOME (~/.cargo/registry/index)

pub fn exists(&self) -> bool[−]

Determines if a crates.io repository exists at self.path

pub fn retrieve(&self) -> Result<()>[−]

Downloads the index to the path specified from the constructor

pub fn update(&self) -> Result<()>[−]

Assumes the index already exists at self.path, and updates it

pub fn retrieve_or_update(&self) -> Result<()>[−]

Downloads the index to the path specified from the constructor

pub fn crate_(&self, crate_name: &str) -> Option<Crate>[−]

Retrieve a single crate by name (case insensitive) from the index

pub fn crates(&self) -> Crates[−]

Retrieve an iterator over all the crates in the index

pub fn crate_index_paths(&self) -> CrateIndexPaths[−]

Returns all the crate index file paths in the index

pub fn path(&self) -> &Path[−]

Get the index directory.

Trait Implementations

impl Clone for Index[+]

[+] Show hidden undocumented items

fn clone(&self) -> Index[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Index[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl PartialEq<Index> for Index[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Index) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Index) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for Index