Enum Category 

pub enum Category {
    Outdated,
    Yanked,
    Vulnerable,
    Unsatisfiable,
    MutableRefPin,
    License,
    Deprecated,
    Other,
}

A category a CheckFinding can be classified into — the seven --fail-on tokens FR-009 defines, plus Category::Other.

Other covers a generate_diagnostics finding that matches none of the seven (an “Unknown package”, a collapsed registry-lookup failure, or a workspace-registry/ offline/dependency-count notice). It is never selectable via --fail-on (#[value(skip)]) and never matched by FailOnPolicy — it exists purely so CheckFinding stays a 1:1 mapping of every diagnostic generate_diagnostics produced, per spec 062 tasks.md T020, rather than silently dropping findings this crate cannot classify.

Serialize/Deserialize (#1626, manual impls below Self::as_str) produce/accept the exact same tokens as Self::as_str — used directly as crate::format::json::FindingDocument::category and as the crate::format::json::ReportDocument::summary map key, so the JSON wire format never stringly-types this closed set.

Examples

use deps_cli::report::Category;

assert_eq!(Category::MutableRefPin.as_str(), "mutable-ref");
assert_eq!(Category::License.as_str(), "license");

Variants

Outdated

A newer version is published for a dependency’s declared requirement.

Yanked

The in-use (or only-satisfying) version has been yanked/retracted.

Vulnerable

A known OSV advisory affects the in-use version.

Unsatisfiable

No published version satisfies the declared requirement.

MutableRefPin

Pinned to a mutable ref (tag/branch) instead of a commit SHA (GitHub Actions/GitLab CI).

License

The resolved license violates the configured allow/deny policy.

Deprecated

The registry reports the package itself as deprecated/abandoned.

Other

A generate_diagnostics finding that does not map to any category above.

Implementations

impl Category

pub const fn as_str(self) -> &'static str

The FR-009 wire token for this category (table/json output and --fail-on).

pub const fn description(self) -> &'static str

A one-line human-readable description, longer than Self::as_str’s wire token — used as SARIF rule metadata (crate::format::sarif) for a rule that only has category-level granularity (no finer diagnostic code). Deliberately close in wording to each variant’s own doc comment above (both describe the same category, and SARIF’s shortDescription is meant to read like ordinary documentation prose) rather than a genuinely distinct text written just to avoid the overlap.

Examples

use deps_cli::report::Category;

assert_eq!(
    Category::Vulnerable.description(),
    "A known security advisory affects the in-use version."
);
assert_eq!(
    Category::License.description(),
    "The resolved license violates the configured allow/deny policy."
);

Trait Implementations

impl Clone for Category

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Category

impl Debug for Category

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Category

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Category

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

Formats the value using the given formatter.

impl Eq for Category

impl Hash for Category

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Category

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Category

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Category

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Category

impl ValueEnum for Category

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.