Enum RemovalStatus 

pub enum RemovalStatus {
    Available,
    AdvisoryDeprecated,
    Yanked,
}

Outcome of a registry’s per-version removal/deprecation signal.

Replaces a bare is_yanked(): bool, which could not distinguish a version a registry has hard-removed from resolution (Yanked) from one that is merely flagged as deprecated/abandoned but still fully installable (AdvisoryDeprecated). Conflating the two caused #347: Composer’s package-level abandoned flag was read through is_yanked(), so every version of an abandoned-but-installable package was filtered out of resolution, turning an existing package into a false “Unknown package” diagnostic.

Call blocks_resolution to decide whether a version may be selected as an upgrade/latest candidate. Call is_flagged only to surface the registry’s flag to the user (e.g. a yanked/deprecated diagnostic) — never to filter resolution.

Examples

use deps_core::RemovalStatus;

assert!(!RemovalStatus::Available.blocks_resolution());
assert!(!RemovalStatus::AdvisoryDeprecated.blocks_resolution());
assert!(RemovalStatus::Yanked.blocks_resolution());

assert!(RemovalStatus::AdvisoryDeprecated.is_flagged());
assert!(RemovalStatus::Yanked.is_flagged());
assert!(!RemovalStatus::Available.is_flagged());

Variants

Available

The registry reports no removal/deprecation signal for this version.

AdvisoryDeprecated

The registry flags this version (or its package) as deprecated/abandoned, but the version remains fully resolvable and installable.

Yanked

The registry has hard-removed this version from fresh resolution (a real yank/retraction). Existing installs may keep using it, but it must not be selected as an upgrade/latest candidate.

Implementations

impl RemovalStatus

pub const fn blocks_resolution(self) -> bool

Whether fresh resolution must skip this version.

true only for Yanked. An AdvisoryDeprecated version is fully installable — excluding it from resolution is what caused #347.

Examples

use deps_core::RemovalStatus;

assert!(!RemovalStatus::AdvisoryDeprecated.blocks_resolution());
assert!(RemovalStatus::Yanked.blocks_resolution());

pub const fn is_flagged(self) -> bool

Whether the registry flags this version at all, hard or advisory.

Use this only to decide whether to surface a warning to the user — never to filter resolution; use blocks_resolution for that.

Examples

use deps_core::RemovalStatus;

assert!(!RemovalStatus::Available.is_flagged());
assert!(RemovalStatus::AdvisoryDeprecated.is_flagged());
assert!(RemovalStatus::Yanked.is_flagged());

pub const fn from_yanked(flag: bool) -> Self

Builds a status from a registry’s hard yanked/retracted boolean flag.

Examples

use deps_core::RemovalStatus;

assert_eq!(RemovalStatus::from_yanked(true), RemovalStatus::Yanked);
assert_eq!(RemovalStatus::from_yanked(false), RemovalStatus::Available);

pub const fn from_advisory(flag: bool) -> Self

Builds a status from a registry’s advisory deprecated/abandoned boolean flag.

Examples

use deps_core::RemovalStatus;

assert_eq!(RemovalStatus::from_advisory(true), RemovalStatus::AdvisoryDeprecated);
assert_eq!(RemovalStatus::from_advisory(false), RemovalStatus::Available);

Trait Implementations

impl Clone for RemovalStatus

fn clone(&self) -> RemovalStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RemovalStatus

impl Debug for RemovalStatus

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

Formats the value using the given formatter.

impl Eq for RemovalStatus

impl Hash for RemovalStatus

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 PartialEq for RemovalStatus

fn eq(&self, other: &RemovalStatus) -> 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 StructuralPartialEq for RemovalStatus