Enum PackageSource

pub enum PackageSource {
    Path(PathBuf),
    Git {
        url: Url,
        git_ref: GitReference,
    },
    RemoteRegistry(Url),
    LocalRegistry(PathBuf),
    CratesIo,
}

Defines a source from which a package can be fetched.

This enum can either be constructed manually, or with associated helper functions on it.

Variants

Path(PathBuf)

Path source:

dep = { path = "some/local/dependency" }

Git

Git source:

regex = { git = "https://github.com/rust-lang/regex", branch = "next" }

Fields

url: Url

git_ref: GitReference

RemoteRegistry(Url)

Remote registry:

some-crate = { version = "1.0", registry = "my-registry" }

LocalRegistry(PathBuf)

Local registry:

some-crate = { version = "1.0", registry = "my-local-registry" }

CratesIo

crates.io:

foo = "1.0.0"

Note that this does not respect .cargo/config.toml, so if default-registry or crates-io are overriden, this would still fetch from crates.io

Implementations

impl PackageSource

pub fn path<P: Into<PathBuf>>(path: P) -> Result<Self, String>

Constructs a new PackageSource::Path from path.

pub fn git<U: AsRef<str>>( url: U, git_ref: Option<GitReference>, ) -> Result<Self, <Url as FromStr>::Err>

Constructs a new PackageSource::Git from repository url and an optional GitReference, if None is provided, GitReference::DefaultBranch will be assumed.

pub fn remote<U: TryInto<Url>>(url: U) -> Result<Self, U::Error>

Constructs a new PackageSource::RemoteRegistry from a registry index url.

pub fn local<P: Into<PathBuf>>(path: P) -> Self

Constructs a new PackageSource::LocalRegistry from a registry index path.

pub fn crates_io() -> Self

Returns PackageSource::CratesIo.

Trait Implementations

impl Clone for PackageSource

fn clone(&self) -> PackageSource

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PackageSource

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

Formats the value using the given formatter.

impl PartialEq for PackageSource

fn eq(&self, other: &PackageSource) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PackageSource

impl StructuralPartialEq for PackageSource