Struct FeatureId

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

An identifier for a (package, feature) pair in a feature graph.

Returned by various methods on FeatureGraph and FeatureQuery.

From impls are available for (&'g PackageId, &'g str) and (&'g PackageId, Option<&'g str>) tuples.

Implementations

impl<'g> FeatureId<'g>

pub fn new(package_id: &'g PackageId, label: FeatureLabel<'g>) -> Self

Creates a new FeatureId with the given PackageId and FeatureLabel.

pub fn named(package_id: &'g PackageId, feature_name: &'g str) -> Self

Creates a new FeatureId representing a named feature in the [features] section, or an implicit named feature created by an optional dependency.

pub fn optional_dependency(package_id: &'g PackageId, dep_name: &'g str) -> Self

Creates a new FeatureId representing an optional dependency.

pub fn base(package_id: &'g PackageId) -> Self

Creates a new FeatureId representing the base feature for a package.

pub fn package_id(&self) -> &'g PackageId

Returns the package ID.

pub fn label(&self) -> FeatureLabel<'g>

Returns the FeatureLabel associated with the feature.

pub fn is_base(&self) -> bool

Returns true if this is the base feature for the package.

pub fn is_optional_dependency(self) -> bool

Returns true if this is an optional dependency.

pub fn is_named(self) -> bool

Returns true if this is a named feature.

Trait Implementations

impl<'g> Clone for FeatureId<'g>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for FeatureId<'g>

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

Formats the value using the given formatter.

impl<'g> Display for FeatureId<'g>

The Display impl prints out:

• {package-id}/[base] for base features.
• {package-id}/feature-name for named features.
• {package-id}/dep:dep-name for optional dependencies.

Examples

use guppy::PackageId;
use guppy::graph::feature::FeatureId;

let package_id = PackageId::new("region 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)");

assert_eq!(
    format!("{}", FeatureId::base(&package_id)),
    "region 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)/[base]"
);

assert_eq!(
    format!("{}", FeatureId::named(&package_id, "foo")),
    "region 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)/foo"
);

assert_eq!(
    format!("{}", FeatureId::optional_dependency(&package_id, "bar")),
    "region 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)/dep:bar"
);

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

Formats the value using the given formatter.

impl<'g> From<(&'g PackageId, FeatureLabel<'g>)> for FeatureId<'g>

fn from((package_id, label): (&'g PackageId, FeatureLabel<'g>)) -> Self

Converts to this type from the input type.

impl<'g> Hash for FeatureId<'g>

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<'g> Ord for FeatureId<'g>

fn cmp(&self, other: &FeatureId<'g>) -> 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<'g> PartialEq for FeatureId<'g>

fn eq(&self, other: &FeatureId<'g>) -> 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<'g> PartialOrd for FeatureId<'g>

fn partial_cmp(&self, other: &FeatureId<'g>) -> 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<'g> Copy for FeatureId<'g>

impl<'g> Eq for FeatureId<'g>

impl<'g> StructuralPartialEq for FeatureId<'g>