Skip to main content

Outcome

Enum Outcome 

Source
pub enum Outcome {
    Applied {
        edit: ManifestEdit,
        target: ConcreteVersion,
    },
    Skipped {
        reason: SkipReason,
        target: Option<ConcreteVersion>,
    },
    RequiresLockfileUpdate {
        target: ConcreteVersion,
    },
    Unfixable(UnfixableReason),
}
Expand description

A dependency’s disposition within an UpdatePlan.

§The invalid state this makes unrepresentable (#1349, #1615)

Before this type carried ManifestEdit directly, PlannedUpdateItem stored outcome and edit: Option<ManifestEdit> as two independent fields the caller had to keep in sync by convention (#1349) — that combination made apply_plan report success (Ok(())) without writing anything. edit was folded into Self::Applied to close that gap, but the dependency’s target version stayed a second, independently settable field on PlannedUpdateItem itself, which reopened the same class of bug: an Applied item with no target. #1615 folds the target into each variant that actually carries one instead, so Self::Applied with no target fails to compile:

ⓘ
use deps_cli::update::Outcome;
use deps_core::edit::ManifestEdit;
use deps_core::position::{Position, Range};

let outcome = Outcome::Applied {
    edit: ManifestEdit {
        range: Range::new(Position::new(0, 9), Position::new(0, 14)),
        new_text: "1.2.0".to_string(),
    },
};

Variants§

§

Applied

A fix plan existed and its edit was written (or would be, under --dry-run). Contributes to exit 0. Carries the edit and its target version — #1349/#1615: this makes “applied, but no edit/target to write” unrepresentable, where separate PlannedUpdateItem fields previously let them drift out of sync (apply_plan would report success without writing anything).

Fields

§edit: ManifestEdit

The edit apply_plan writes.

§target: ConcreteVersion

The version this edit moves the dependency to.

§

Skipped

Excluded from this run, for SkipReason.

Fields

§reason: SkipReason

Why this candidate was skipped.

§target: Option<ConcreteVersion>

The target version considered for this occurrence, when one was known — None when no concrete target exists (an unplannable latest, an ignore-rule skip of an OSV-blocked fallback, or — under --security-only — a not-requested item).

§

RequiresLockfileUpdate

(--security-only only) The dependency is Vulnerable, but its declared requirement already admits the fix target, so no requirement-level edit exists — needs #1116. Contributes to exit 1.

Fields

§target: ConcreteVersion

The already-admitted fix target.

§

Unfixable(UnfixableReason)

(--security-only only) No verified fix could be written, for UnfixableReason. Contributes to exit 1.

Implementations§

Source§

impl Outcome

Source

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

The FR-021 wire token (--format json’s outcome field, and the table’s [..] prefix): one of exactly applied / skipped / requires-lockfile-update / unfixable — a SkipReason/UnfixableReason’s own detail is carried in PlannedUpdateItem::reason instead, not folded into this token.

Source

pub const fn target(&self) -> Option<&ConcreteVersion>

This outcome’s target version, when its variant carries one — the sole read path for a dependency’s considered/applied target (#1615), used by PlannedUpdateItem::target and every formatter.

Trait Implementations§

Source§

impl Clone for Outcome

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Outcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Outcome

Source§

impl From<&Outcome> for OutcomeToken

Source§

fn from(outcome: &Outcome) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Outcome

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Outcome

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more