Struct cargo::core::dependency::Dependency

pub struct Dependency { /* private fields */ }

Information about a dependency requested by a Cargo manifest. Cheap to copy.

Implementations

impl Dependency

pub fn parse(
    name: impl Into<InternedString>,
    version: Option<&str>,
    source_id: SourceId
) -> CargoResult<Dependency>

Attempt to create a Dependency from an entry in the manifest.

pub fn new_override(name: InternedString, source_id: SourceId) -> Dependency

pub fn version_req(&self) -> &OptVersionReq

pub fn name_in_toml(&self) -> InternedString

This is the name of this Dependency as listed in Cargo.toml.

Or in other words, this is what shows up in the [dependencies] section on the left hand side. This is not the name of the package that’s being depended on as the dependency can be renamed. For that use package_name below.

Both of the dependencies below return foo for name_in_toml:

[dependencies]
foo = "0.1"

and …

[dependencies]
foo = { version = "0.1", package = 'bar' }

pub fn package_name(&self) -> InternedString

The name of the package that this Dependency depends on.

Usually this is what’s written on the left hand side of a dependencies section, but it can also be renamed via the package key.

Both of the dependencies below return foo for package_name:

[dependencies]
foo = "0.1"

and …

[dependencies]
bar = { version = "0.1", package = 'foo' }

pub fn source_id(&self) -> SourceId

pub fn registry_id(&self) -> Option<SourceId>

pub fn set_registry_id(&mut self, registry_id: SourceId) -> &mut Dependency

pub fn kind(&self) -> DepKind

pub fn is_public(&self) -> bool

pub fn set_public(&mut self, public: bool) -> &mut Dependency

Sets whether the dependency is public.

pub fn specified_req(&self) -> bool

pub fn platform(&self) -> Option<&Platform>

If none, this dependencies must be built for all platforms. If some, it must only be built for the specified platform.

pub fn explicit_name_in_toml(&self) -> Option<InternedString>

The renamed name of this dependency, if any.

If the package key is used in Cargo.toml then this returns the same value as name_in_toml.

pub fn set_kind(&mut self, kind: DepKind) -> &mut Dependency

pub fn set_features(
    &mut self,
    features: impl IntoIterator<Item = impl Into<InternedString>>
) -> &mut Dependency

Sets the list of features requested for the package.

pub fn set_default_features(
    &mut self,
    default_features: bool
) -> &mut Dependency

Sets whether the dependency requests default features of the package.

pub fn set_optional(&mut self, optional: bool) -> &mut Dependency

Sets whether the dependency is optional.

pub fn set_source_id(&mut self, id: SourceId) -> &mut Dependency

Sets the source ID for this dependency.

pub fn set_version_req(&mut self, req: VersionReq) -> &mut Dependency

Sets the version requirement for this dependency.

pub fn set_platform(&mut self, platform: Option<Platform>) -> &mut Dependency

pub fn set_explicit_name_in_toml(
    &mut self,
    name: impl Into<InternedString>
) -> &mut Dependency

pub fn lock_to(&mut self, id: PackageId) -> &mut Dependency

Locks this dependency to depending on the specified package ID.

pub fn lock_version(&mut self, version: &Version) -> &mut Dependency

Locks this dependency to a specified version.

Mainly used in dependency patching like [patch] or [replace], which doesn’t need to lock the entire dependency to a specific PackageId.

pub fn is_locked(&self) -> bool

Returns true if this is a “locked” dependency. Basically a locked dependency has an exact version req, but not vice versa.

pub fn is_transitive(&self) -> bool

Returns false if the dependency is only used to build the local package.

pub fn is_build(&self) -> bool

pub fn is_optional(&self) -> bool

pub fn uses_default_features(&self) -> bool

Returns true if the default features of the dependency are requested.

pub fn features(&self) -> &[InternedString]

Returns the list of features that are requested by the dependency.

pub fn matches(&self, sum: &Summary) -> bool

Returns true if the package (sum) can fulfill this dependency request.

pub fn matches_ignoring_source(&self, id: PackageId) -> bool

Returns true if the package (id) can fulfill this dependency request.

pub fn matches_id(&self, id: PackageId) -> bool

Returns true if the package (id) can fulfill this dependency request.

pub fn map_source(
    self,
    to_replace: SourceId,
    replace_with: SourceId
) -> Dependency

Trait Implementations

impl Clone for Dependency

fn clone(&self) -> Dependency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dependency

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

Formats the value using the given formatter.

impl Hash for Dependency

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Dependency> for Dependency

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

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

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

This method tests for !=.

impl Serialize for Dependency

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

Serialize this value into the given Serde serializer.

impl Eq for Dependency

impl StructuralEq for Dependency

impl StructuralPartialEq for Dependency