Struct DependencyGroupsWithDefaults 

pub struct DependencyGroupsWithDefaults { /* private fields */ }

A trivial newtype wrapped around DependencyGroups that signifies “defaults applied”

It includes a copy of the previous semantics to provide info on if the group being a default actually affected it being enabled, because it’s obviously “correct”. (These are Arcs so it’s ~free to hold onto the previous semantics)

Implementations

impl DependencyGroupsWithDefaults

pub fn none() -> Self

Do not enable any groups

Many places in the code need to know what dependency-groups are active, but various commands or subsystems never enable any dependency-groups, in which case they want this.

pub fn contains_because_default(&self, group: &GroupName) -> bool

Returns true if the specification was enabled, and only because it was a default

Methods from Deref<Target = DependencyGroups>

pub fn with_defaults( &self, defaults: DefaultGroups, ) -> DependencyGroupsWithDefaults

Apply defaults to a base DependencyGroups.

This is appropriate in projects, where the dev group is synced by default.

Methods from Deref<Target = DependencyGroupsInner>

pub fn prod(&self) -> bool

Returns true if packages other than the ones referenced by these dependency-groups should be considered.

That is, if I tell you to install a project and this is false, you should ignore the project itself and all its dependencies, and instead just install the dependency-groups.

(This is really just asking if an –only flag was passed.)

pub fn contains(&self, group: &GroupName) -> bool

Returns true if the specification includes the given group.

pub fn desugarred_names(&self) -> impl Iterator<Item = &GroupName>

Iterate over all groups that we think should exist.

pub fn group_names<'a, Names>( &'a self, all_names: Names, ) -> impl Iterator<Item = &'a GroupName> + 'a

where Names: Iterator<Item = &'a GroupName> + 'a,

Returns an iterator over all groups that are included in the specification, assuming all_names is an iterator over all groups.

pub fn explicit_names(&self) -> impl Iterator<Item = &GroupName>

Iterate over all groups the user explicitly asked for on the CLI

pub fn is_empty(&self) -> bool

Returns true if the specification will have no effect.

pub fn history(&self) -> &DependencyGroupsHistory

Get the raw history for diagnostics

Trait Implementations

impl Clone for DependencyGroupsWithDefaults

fn clone(&self) -> DependencyGroupsWithDefaults

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DependencyGroupsWithDefaults

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

Formats the value using the given formatter.

impl Deref for DependencyGroupsWithDefaults

type Target = DependencyGroups

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.