Struct FeatureList

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

A sorted, deduplicated list of features from a single package.

This provides a convenient way to query and print out lists of features.

Returned by methods on FeatureSet.

Implementations

impl<'g> FeatureList<'g>

pub fn new( package: PackageMetadata<'g>, labels: impl IntoIterator<Item = FeatureLabel<'g>>, ) -> Self

Creates a new FeatureList from a package and an iterator over feature labels.

pub fn package(&self) -> &PackageMetadata<'g>

Returns the package corresponding to this feature list.

pub fn contains(&self, label: FeatureLabel<'_>) -> bool

Returns true if this feature list contains this feature label.

pub fn has_base(&self) -> bool

Returns true if this feature list contains the “base” feature.

The “base” feature represents the package with no features enabled.

pub fn has_named_feature(&self, feature_name: &str) -> bool

Returns true if this feature list contains the specified named feature.

pub fn has_optional_dependency(&self, dep_name: &str) -> bool

Returns true if this feature list contains the specified optional dependency.

pub fn labels(&self) -> &[FeatureLabel<'g>]

Returns the list of labels as a slice.

This slice is guaranteed to be sorted and unique.

pub fn named_features(&self) -> impl Iterator<Item = &'g str> + '_

Returns an iterator containing all named features.

The iterator is guaranteed to be sorted and unique.

pub fn optional_deps(&self) -> impl Iterator<Item = &'g str> + '_

Returns an iterator containing all optional dependencies.

The iterator is guaranteed to be sorted and unique.

pub fn iter<'a>(&'a self) -> Iter<'g, 'a>

Returns a borrowed iterator over feature IDs.

pub fn display_features<'a>(&'a self) -> DisplayFeatures<'g, 'a>

Returns a pretty-printer over the list of feature labels.

pub fn into_labels(self) -> Vec<FeatureLabel<'g>>

Returns a vector of feature labels.

The vector is guaranteed to be sorted and unique.

Trait Implementations

impl<'g> Clone for FeatureList<'g>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FeatureList<'_>

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

Formats the value using the given formatter.

impl<'a, 'g> IntoIterator for &'a FeatureList<'g>

type Item = FeatureId<'g>

The type of the elements being iterated over.

type IntoIter = Iter<'g, 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'g> IntoIterator for FeatureList<'g>

type Item = FeatureId<'g>

The type of the elements being iterated over.

type IntoIter = IntoIter<'g>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'g> PartialEq for FeatureList<'g>

fn eq(&self, other: &FeatureList<'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> Eq for FeatureList<'g>

impl<'g> StructuralPartialEq for FeatureList<'g>