Struct Index

pub struct Index { /* private fields */ }

A representation of a crates registry, backed by both a directory and a git repository on the filesystem.

This struct is essentially a thin wrapper around both an index Tree and a git Repository.

It functions exactly the same way as a Tree, except that all changes to the crates index are also committed to the git repository, which allows this to be synced to a remote.

Implementations

impl Index

pub fn initialise<'a>( root: impl Into<PathBuf>, download: impl Into<String>, ) -> Builder<'a>

Create a new index.

The root path, and the URL for downloading .crate files is required. Additional options can be set using the builder API (see Builder for options).

Example

Basic Config

use crate_index::Index;
let root = "/index";
let download = "https://my-crates-server.com/api/v1/crates/{crate}/{version}/download";

let index = Index::initialise(root, download).build().await?;

More Options

use crate_index::{Index, Url};
let root = "/index";
let download = "https://my-crates-server.com/api/v1/crates/{crate}/{version}/download";
let origin = Url::parse("https://github.com/crates/index.git").unwrap();


let index = Index::initialise(root, download)
    .api(Url::parse("https://my-crates-server.com/").unwrap())
    .allowed_registry(Url::parse("https://my-intranet:8080/index").unwrap())
    .allow_crates_io()
    .origin(origin)
    .build()
    .await?;

pub async fn open(root: impl Into<PathBuf>) -> Result<Self>

Open an existing index at the given root path.

Example

use crate_index::Index;
let root = "/index";

let index = Index::open("/index").await?;

pub async fn insert(&mut self, crate_metadata: Metadata) -> Result<()>

Insert crate [‘Metadata’] into the index.

Errors

This method can fail if the metadata is deemed to be invalid, or if the filesystem cannot be written to.

pub fn root(&self) -> &PathBuf

The location on the filesystem of the root of the index

pub fn download(&self) -> &String

The Url for downloading .crate files

pub fn api(&self) -> &Option<Url>

The Url of the API

pub fn allowed_registries(&self) -> &Vec<Url>

The list of registries which crates in this index are allowed to have dependencies on

pub fn into_parts(self) -> (Tree, Repository)

Split this Index into its constituent parts