Struct IndexLocation

pub struct IndexLocation<'il> {
    pub url: IndexUrl<'il>,
    pub root: IndexPath,
}

Helper for constructing an index location, consisting of the remote url for the index and the local location on disk

Fields

url: IndexUrl<'il>

The remote url of the registry index

root: IndexPath

The local disk path of the index

Implementations

impl<'il> IndexLocation<'il>

pub fn new(url: IndexUrl<'il>) -> Self

Constructs an index with the specified url located in the default cargo home

pub fn with_root(self, root: Option<PathBuf>) -> Self

Changes the root location of the index on the local disk.

If not called, or set to None, the default cargo home disk location is used as the root

pub fn into_parts(self) -> Result<(PathBuf, String), Error>

Obtains the full local disk path and URL of this index location

Trait Implementations

impl<'il> Default for IndexLocation<'il>

fn default() -> IndexLocation<'il>

Returns the “default value” for a type.