Struct rustwide::Crate

pub struct Crate(_);

A Rust crate that can be used with rustwide.

Implementations

impl Crate

pub fn registry( registry: AlternativeRegistry, name: &str, version: &str ) -> Self

Load a crate from specified registry.

pub fn crates_io(name: &str, version: &str) -> Self

Load a crate from the crates.io registry.

pub fn git(url: &str) -> Self

Load a crate from a git repository. The full URL needed to clone the repo has to be provided.

pub fn local(path: &Path) -> Self

Load a crate from a directory in the local filesystem.

pub fn fetch(&self, workspace: &Workspace) -> Result<(), Error>

Fetch the crate’s source code and cache it in the workspace. This method will reach out to the network for some crate types.

pub fn purge_from_cache(&self, workspace: &Workspace) -> Result<(), Error>

Remove the cached copy of this crate. The method will do nothing if the crate isn’t cached.

pub fn git_commit(&self, workspace: &Workspace) -> Option<String>

Get this crate’s git commit. This method is best-effort, and currently works just for git crates. If the commit can’t be retrieved None will be returned.

Trait Implementations

impl Display for Crate

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

Formats the value using the given formatter.