Struct cargo::core::source::SourceId

pub struct SourceId { /* private fields */ }

Unique identifier for a source of packages.

Implementations

impl SourceId

pub fn from_url(string: &str) -> CargoResult<SourceId>

Parses a source URL and returns the corresponding ID.

Example

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

pub fn as_url(&self) -> SourceIdAsUrl<'_>

A view of the SourceId that can be Displayed as a URL.

pub fn for_path(path: &Path) -> CargoResult<SourceId>

Creates a SourceId from a filesystem path.

path: an absolute path.

pub fn for_git(url: &Url, reference: GitReference) -> CargoResult<SourceId>

Creates a SourceId from a Git reference.

pub fn for_registry(url: &Url) -> CargoResult<SourceId>

Creates a SourceId from a remote registry URL when the registry name cannot be determined, e.g. a user passes --index directly from CLI.

Use SourceId::for_alt_registry if a name can provided, which generates better messages for cargo.

pub fn for_alt_registry(url: &Url, name: &str) -> CargoResult<SourceId>

Creates a SourceId from a remote registry URL with given name.

pub fn for_local_registry(path: &Path) -> CargoResult<SourceId>

Creates a SourceId from a local registry path.

pub fn for_directory(path: &Path) -> CargoResult<SourceId>

Creates a SourceId from a directory path.

pub fn crates_io(config: &Config) -> CargoResult<SourceId>

Returns the SourceId corresponding to the main repository.

This is the main cargo registry by default, but it can be overridden in a .cargo/config.toml.

pub fn alt_registry(config: &Config, key: &str) -> CargoResult<SourceId>

Gets the SourceId associated with given name of the remote registry.

pub fn url(&self) -> &Url

Gets this source URL.

pub fn canonical_url(&self) -> &CanonicalUrl

Gets the canonical URL of this source, used for internal comparison purposes.

pub fn display_index(self) -> String

pub fn display_registry_name(self) -> String

pub fn is_path(self) -> bool

Returns true if this source is from a filesystem path.

pub fn local_path(self) -> Option<PathBuf>

Returns the local path if this is a path dependency.

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 load<'a>(
    self,
    config: &'a Config,
    yanked_whitelist: &HashSet<PackageId>
) -> CargoResult<Box<dyn Source + 'a>>

Creates an implementation of Source corresponding to this ID.

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

Gets the value of the precise field.

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

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

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

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.

pub fn stable_hash<S: Hasher>(self, workspace: &Path, into: &mut S)

Hashes self.

For paths, remove the workspace prefix so the same source will give the same hash in different locations.

pub fn full_eq(self, other: SourceId) -> bool

pub fn full_hash<S: Hasher>(self, into: &mut S)

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<'de> Deserialize<'de> for SourceId

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

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

fn hash<S: Hasher>(&self, into: &mut S)

Feeds this value into the given Hasher.

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<SourceId> for SourceId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for SourceId

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

Serialize this value into the given Serde serializer.

impl Copy for SourceId

impl Eq for SourceId

impl StructuralEq for SourceId