Struct Builder

pub struct Builder<'a> { /* private fields */ }

A builder for initialising a new Index

Implementations

impl<'a> Builder<'a>

pub fn api(self, api: Url) -> Self

The API should implement the REST interface as defined in the Cargo book

pub fn origin(self, remote: Url) -> Self

Add a remote to the repository

pub fn allowed_registry(self, registry: Url) -> Self

Add an allowed registry.

Crates in this registry are only allowed to have dependencies which are also in this registry, or in one of the allowed registries.

Add multiple registries my calling this method multiple times.

pub fn allow_crates_io(self) -> Self

Add crates.io as an allowed registry.

You will almost always want this, so this exists as a handy shortcut.

pub fn identity(self, username: &'a str, email: &'a str) -> Self

Optionally set the username and email for the git repository

pub async fn build(self) -> Result<Index>

Construct the Index with the given parameters.

Errors

This method can fail if the root path doesn’t exist, or the filesystem cannot be written to.