Struct ConditionalLink

pub struct ConditionalLink<'g> { /* private fields */ }

A feature dependency that is conditionally activated.

A ConditionalLink is typically a link across packages. For example:

[package]
name = "main"

[dependencies]
dep = { ... }

[dev-dependencies]
dev-dep = { ... }

[target.'cfg(unix)'.dependencies]
unix-dep = { ... }

[features]
feat = ["dep/feat", "dev-dep/feat", "unix-dep/feat"]

In this example, there are ConditionalLinks from main/feat to dep/feat, dev-dep/feat and unix-dep/feat. Each link is only activated if the conditions for it are met. For example, the link to dev-dep/feat is only followed if Cargo is interested in dev-dependencies of main.

If a dependency, for example unix-dep above, is optional, an implicit feature is created in the package main with the name unix-dep. In this case, the dependency from main/feat to main/unix-dep is also a ConditionalLink representing the same cfg(unix) condition.

Implementations

impl<'g> ConditionalLink<'g>

pub fn from(&self) -> FeatureMetadata<'g>

Returns the feature which depends on the to feature.

pub fn to(&self) -> FeatureMetadata<'g>

Returns the feature which is depended on by the from feature.

pub fn endpoints(&self) -> (FeatureMetadata<'g>, FeatureMetadata<'g>)

Returns the endpoints as a pair of features (from, to).

pub fn normal(&self) -> PlatformStatus<'g>

Returns details about this feature dependency from the [dependencies] section.

pub fn build(&self) -> PlatformStatus<'g>

Returns details about this feature dependency from the [build-dependencies] section.

pub fn dev(&self) -> PlatformStatus<'g>

Returns details about this feature dependency from the [dev-dependencies] section.

pub fn status_for_kind(&self, kind: DependencyKind) -> PlatformStatus<'g>

Returns details about this feature dependency from the section specified by the given dependency kind.

pub fn dev_only(&self) -> bool

Returns true if this edge is dev-only, i.e. code from this edge will not be included in normal builds.

pub fn package_link(&self) -> PackageLink<'g>

Returns the PackageLink from which this ConditionalLink was derived.

Trait Implementations

impl<'g> Clone for ConditionalLink<'g>

fn clone(&self) -> ConditionalLink<'g>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for ConditionalLink<'g>

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

Formats the value using the given formatter.

impl<'g> Copy for ConditionalLink<'g>