Enum guppy::graph::EnabledStatus

pub enum EnabledStatus {
    Always,
    Optional,
    Never,
    Unknown(UnknownStatus),
}

Whether a dependency or feature is enabled on a specific platform.

Returned by the methods on DependencyMetadata.

Examples

[dependencies]
once_cell = "1"

The dependency and default features are always enabled on all platforms.

[dependencies]
once_cell = { version = "1", optional = true }

The dependency and default features are optional on all platforms.

[target.'cfg(windows)'.dependencies]
once_cell = { version = "1", optional = true }

On Windows, the dependency and default features are both optional. On non-Windows platforms, the dependency and default features are never enabled.

[dependencies]
once_cell = { version = "1", optional = true }

[target.'cfg(windows)'.dependencies]
once_cell = { version = "1", optional = false, default-features = false }

On Windows, the dependency is always enabled and default features are optional (i.e. enabled if the once_cell feature is turned on).

On Unix platforms, the dependency and default features are both optional.

Variants

Always

This dependency or feature is always enabled on this platform.

Optional

This dependency or feature is optionally enabled on this platform.

Never

This dependency or feature is never enabled on this platform, even if the optional dependency is turned on.

Unknown(UnknownStatus)

The status of this dependency is unknown because the evaluation involved target features whose status is unknown.

This can only be returned if the set of target features is unknown. In particular, it is guaranteed never to be returned for queries being evaluated against the current platform, since the exact set of target features is already known.

Methods

impl EnabledStatus

pub fn is_known(self) -> bool

Returns true if the enabled status is not Unknown.

Trait Implementations

impl Clone for EnabledStatus

fn clone(&self) -> EnabledStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EnabledStatus

impl Debug for EnabledStatus

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

Formats the value using the given formatter.

impl Eq for EnabledStatus

impl Hash for EnabledStatus

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 Ord for EnabledStatus

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

fn eq(&self, other: &EnabledStatus) -> bool

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

fn ne(&self, other: &EnabledStatus) -> bool

This method tests for !=.

impl PartialOrd<EnabledStatus> for EnabledStatus

fn partial_cmp(&self, other: &EnabledStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &EnabledStatus) -> bool

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

fn le(&self, other: &EnabledStatus) -> bool

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

fn gt(&self, other: &EnabledStatus) -> bool

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

fn ge(&self, other: &EnabledStatus) -> bool

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

impl StructuralEq for EnabledStatus

impl StructuralPartialEq for EnabledStatus