pub struct SourceId {
inner: &'static SourceIdInner,
}
Expand description
Unique identifier for a source of packages.
Cargo uniquely identifies packages using PackageId
, a combination of the
package name, version, and the code source. SourceId
exactly represents
the “code source” in PackageId
. See SourceId::hash
to learn what are
taken into account for the uniqueness of a source.
SourceId
is usually associated with an instance of Source
, which is
supposed to provide a SourceId
via Source::source_id
method.
Fields§
§inner: &'static SourceIdInner
Implementations§
source§impl SourceId
impl SourceId
sourcefn new(kind: SourceKind, url: Url, key: Option<KeyOf>) -> CargoResult<SourceId>
fn new(kind: SourceKind, url: Url, key: Option<KeyOf>) -> CargoResult<SourceId>
Creates a SourceId
object from the kind and URL.
The canonical url will be calculated, but the precise field will not
sourcefn wrap(inner: SourceIdInner) -> SourceId
fn wrap(inner: SourceIdInner) -> SourceId
Interns the value and returns the wrapped type.
fn remote_source_kind(url: &Url) -> SourceKind
sourcepub fn from_url(string: &str) -> CargoResult<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");
sourcepub fn as_url(&self) -> SourceIdAsUrl<'_>
pub fn as_url(&self) -> SourceIdAsUrl<'_>
A view of the SourceId
that can be Display
ed as a URL.
sourcepub fn as_encoded_url(&self) -> SourceIdAsUrl<'_>
pub fn as_encoded_url(&self) -> SourceIdAsUrl<'_>
Like Self::as_url
but with URL parameters encoded.
sourcepub fn for_path(path: &Path) -> CargoResult<SourceId>
pub fn for_path(path: &Path) -> CargoResult<SourceId>
Creates a SourceId
from a filesystem path.
path
: an absolute path.
sourcepub fn for_git(url: &Url, reference: GitReference) -> CargoResult<SourceId>
pub fn for_git(url: &Url, reference: GitReference) -> CargoResult<SourceId>
Creates a SourceId
from a Git reference.
sourcepub fn for_registry(url: &Url) -> CargoResult<SourceId>
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.
sourcepub fn for_alt_registry(url: &Url, key: &str) -> CargoResult<SourceId>
pub fn for_alt_registry(url: &Url, key: &str) -> CargoResult<SourceId>
Creates a SourceId
for a remote registry from the [registries]
table or crates.io.
sourcepub fn for_source_replacement_registry(
url: &Url,
key: &str
) -> CargoResult<SourceId>
pub fn for_source_replacement_registry( url: &Url, key: &str ) -> CargoResult<SourceId>
Creates a SourceId
for a remote registry from the [source]
replacement table.
sourcepub fn for_local_registry(path: &Path) -> CargoResult<SourceId>
pub fn for_local_registry(path: &Path) -> CargoResult<SourceId>
Creates a SourceId
from a local registry path.
sourcepub fn for_directory(path: &Path) -> CargoResult<SourceId>
pub fn for_directory(path: &Path) -> CargoResult<SourceId>
Creates a SourceId
from a directory path.
sourcepub fn crates_io(config: &Config) -> CargoResult<SourceId>
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
.
sourcepub fn crates_io_maybe_sparse_http(config: &Config) -> CargoResult<SourceId>
pub fn crates_io_maybe_sparse_http(config: &Config) -> CargoResult<SourceId>
Returns the SourceId
corresponding to the main repository, using the
sparse HTTP index if allowed.
sourcepub fn crates_io_is_sparse(config: &Config) -> CargoResult<bool>
pub fn crates_io_is_sparse(config: &Config) -> CargoResult<bool>
Returns whether to access crates.io over the sparse protocol.
sourcepub fn alt_registry(config: &Config, key: &str) -> CargoResult<SourceId>
pub fn alt_registry(config: &Config, key: &str) -> CargoResult<SourceId>
Gets the SourceId
associated with given name of the remote registry.
sourcepub fn canonical_url(&self) -> &CanonicalUrl
pub fn canonical_url(&self) -> &CanonicalUrl
Gets the canonical URL of this source, used for internal comparison purposes.
sourcepub fn display_index(self) -> String
pub fn display_index(self) -> String
Displays the text “crates.io index” for Cargo shell status output.
sourcepub fn display_registry_name(self) -> String
pub fn display_registry_name(self) -> String
Displays the name of a registry if it has one. Otherwise just the URL.
sourcepub fn alt_registry_key(&self) -> Option<&str>
pub fn alt_registry_key(&self) -> Option<&str>
Gets the name of the remote registry as defined in the [registries]
table,
or the built-in crates-io
key.
sourcepub fn local_path(self) -> Option<PathBuf>
pub fn local_path(self) -> Option<PathBuf>
Returns the local path if this is a path dependency.
sourcepub fn is_registry(self) -> bool
pub fn is_registry(self) -> bool
Returns true
if this source is from a registry (either local or not).
sourcepub fn is_remote_registry(self) -> bool
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
.
sourcepub fn load<'a>(
self,
config: &'a Config,
yanked_whitelist: &HashSet<PackageId>
) -> CargoResult<Box<dyn Source + 'a>>
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.
yanked_whitelist
— Packages allowed to be used, even if they are yanked.
sourcepub fn git_reference(self) -> Option<&'static GitReference>
pub fn git_reference(self) -> Option<&'static GitReference>
Gets the Git reference if this is a git source, otherwise None
.
sourcepub fn precise_registry_version(self, name: &str) -> Option<(Version, Version)>
pub fn precise_registry_version(self, name: &str) -> Option<(Version, Version)>
Check if the precise data field stores information for this name
from a call to SourceId::with_precise_registry_version.
If so return the version currently in the lock file and the version to be updated to. If specified, our own source will have a precise version listed of the form
sourcepub fn with_precise(self, v: Option<String>) -> SourceId
pub fn with_precise(self, v: Option<String>) -> SourceId
Creates a new SourceId
from this source with the given precise
.
sourcepub fn with_precise_registry_version(
self,
name: impl Display,
version: &Version,
precise: &str
) -> CargoResult<SourceId>
pub fn with_precise_registry_version( self, name: impl Display, version: &Version, precise: &str ) -> CargoResult<SourceId>
When updating a lock file on a version using cargo update --precise
the requested version is stored in the precise field.
On a registry dependency we also need to keep track of the package that
should be updated and even which of the versions should be updated.
All of this gets encoded in the precise field using this method.
The data can be read with SourceId::precise_registry_version
sourcepub fn is_crates_io(self) -> bool
pub fn is_crates_io(self) -> bool
Returns true
if the remote registry is the standard https://crates.io.
sourcepub fn stable_hash<S: Hasher>(self, workspace: &Path, into: &mut S)
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, helping reproducible builds.
pub fn full_eq(self, other: SourceId) -> bool
pub fn full_hash<S: Hasher>(self, into: &mut S)
Trait Implementations§
source§impl<'de> Deserialize<'de> for SourceId
impl<'de> Deserialize<'de> for SourceId
source§fn deserialize<D>(d: D) -> Result<SourceId, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(d: D) -> Result<SourceId, D::Error>where D: Deserializer<'de>,
source§impl Hash for SourceId
impl Hash for SourceId
The hash of SourceId is used in the name of some Cargo folders, so shouldn’t
vary. as_str
gives the serialisation of a url (which has a spec) and so
insulates against possible changes in how the url crate does hashing.
source§impl Ord for SourceId
impl Ord for SourceId
source§impl PartialEq<SourceId> for SourceId
impl PartialEq<SourceId> for SourceId
source§impl PartialOrd<SourceId> for SourceId
impl PartialOrd<SourceId> for SourceId
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl Copy for SourceId
impl Eq for SourceId
impl StructuralEq for SourceId
Auto Trait Implementations§
impl RefUnwindSafe for SourceId
impl Send for SourceId
impl Sync for SourceId
impl Unpin for SourceId
impl UnwindSafe for SourceId
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Serialize for Twhere
T: Serialize + ?Sized,
impl<T> Serialize for Twhere T: Serialize + ?Sized,
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 8 bytes