Struct guppy::graph::feature::FeatureId

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

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, feature: &'g str) -> Self

Creates a new FeatureId.

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 feature(&self) -> Option<&'g str>

Returns the name of the feature, or None if this is the "base" feature for this package.

pub fn is_base(&self) -> bool

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

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

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}/feature, or {package id}/[base].

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::new(&package_id, "foo")),
    "region 2.1.2 (registry+https://github.com/rust-lang/crates.io-index)/foo"
);

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

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

Formats the value using the given formatter.

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

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

fn from((package_id, feature): (&'g PackageId, &'g str)) -> Self

Performs the conversion.

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

fn from((package_id, feature): (&'g PackageId, Option<&'g str>)) -> Self

Performs the conversion.

impl<'g> From<FeatureId<'g>> for (PackageId, Option<String>)

fn from(feature_id: FeatureId<'g>) -> Self

Performs the conversion.

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, 

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'g> PartialEq<FeatureId<'g>> for FeatureId<'g>

fn eq(&self, other: &FeatureId<'g>) -> bool

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

fn ne(&self, other: &FeatureId<'g>) -> bool

This method tests for !=.

impl<'g> PartialOrd<FeatureId<'g>> 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: &FeatureId<'g>) -> bool

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

fn le(&self, other: &FeatureId<'g>) -> bool

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

fn gt(&self, other: &FeatureId<'g>) -> bool

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

fn ge(&self, other: &FeatureId<'g>) -> bool

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

impl<'g> StructuralEq for FeatureId<'g>

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