Struct SourceId

pub struct SourceId { /* private fields */ }

Unique identifier for a source of packages.

Implementations

impl SourceId

pub fn normalize_git_source_for_dependency(&self) -> Self

SourceIds with git references used in package.source fields are subtly different than those in parenthesized source URLs that appear in disambiguated entries of package.dependencies: the former have the form ?rev=ABBREV#FULLHASH whereas the latter have the form ?rev=FULLHASH. This method changes the former into the latter, and is used in impl From<&Package> for Dependency.

pub fn from_url(string: &str) -> Result<Self>

Parses a source URL and returns the corresponding ID.

Example

use cargo_lock::SourceId;
SourceId::from_url("git+https://github.com/alexcrichton/\
                    libssh2-static-sys#80e71a3021618eb05\
                    656c58fb7c5ef5f12bc747f");

pub fn for_path(path: &Path) -> Result<Self>

Available on Unix or Windows only.

Creates a SourceId from a filesystem path.

path: an absolute path.

pub fn for_git(url: &Url, reference: GitReference) -> Result<Self>

Creates a SourceId from a Git reference.

pub fn for_registry(url: &Url) -> Result<Self>

Creates a SourceId from a remote registry URL.

pub fn for_local_registry(path: &Path) -> Result<Self>

Available on Unix or Windows only.

Creates a SourceId from a local registry path.

pub fn for_directory(path: &Path) -> Result<Self>

Available on Unix or Windows only.

Creates a SourceId from a directory path.

pub fn url(&self) -> &Url

Gets this source URL.

pub fn kind(&self) -> &SourceKind

Get the kind of source.

pub fn display_index(&self) -> String

Human-friendly description of an index

pub fn display_registry_name(&self) -> String

Human-friendly description of a registry name

pub fn is_path(&self) -> bool

Returns true if this source is from a filesystem path.

pub fn is_registry(&self) -> bool

Returns true if this source is from a registry (either local or not).

pub fn is_remote_registry(&self) -> bool

Returns true if this source is a “remote” registry.

“remote” may also mean a file URL to a git index, so it is not necessarily “remote”. This just means it is not local-registry.

pub fn is_git(&self) -> bool

Returns true if this source from a Git repository.

pub fn precise(&self) -> Option<&str>

Gets the value of the precise field.

pub fn git_reference(&self) -> Option<&GitReference>

Gets the Git reference if this is a git source, otherwise None.

pub fn with_precise(&self, v: Option<String>) -> Self

Creates a new SourceId from this source with the given precise.

pub fn is_default_registry(&self) -> bool

Returns true if the remote registry is the standard https://crates.io.

Trait Implementations

impl Clone for SourceId

fn clone(&self) -> SourceId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceId

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

Formats the value using the given formatter.

impl Default for SourceId

fn default() -> SourceId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceId

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for SourceId

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

Formats the value using the given formatter.

impl FromStr for SourceId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for SourceId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SourceId

fn cmp(&self, other: &SourceId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SourceId

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

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

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 PartialOrd for SourceId

fn partial_cmp(&self, other: &SourceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SourceId

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for SourceId

impl StructuralPartialEq for SourceId