Skip to main content

BatchOutcome

Struct BatchOutcome 

Source
#[non_exhaustive]
pub struct BatchOutcome { pub succeeded: Vec<String>, pub unchanged: Vec<String>, pub failed: Vec<(String, Error)>, pub kept_untracked: Vec<PathBuf>, pub cancelled: Vec<String>, pub re_enabled: Vec<String>, pub kept_disabled: Vec<String>, }
Expand description

The per-item result of a batch operation.

A batch does not stop at the first failure: an operation that already mutated earlier items has to report which ones, so failed carries the reason per item rather than collapsing to a single error.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§succeeded: Vec<String>

Identifiers the operation completed.

For uninstall_batch and set_enabled_batch, this is exactly the requested identifiers, in the order each completed, matching this field’s name at face value. For install_batch it does not: that function sorts and deduplicates it, and fills it with the whole dependency closure that installed rather than only what the caller asked for. A caller zipping batch.desired against this positionally, or reading succeeded.len() as “how many of my requested items worked”, is wrong for install by however many dependencies were pulled in.

§unchanged: Vec<String>

Identifiers left alone because the version already recorded in mods.yml is the one that would be installed. Only install_batch fills this; like succeeded it covers the dependency closure, sorted and deduplicated, and never names anything succeeded or failed also names.

§failed: Vec<(String, Error)>

Identifiers that failed, each with the reason.

§kept_untracked: Vec<PathBuf>

Untracked folders an uninstall left in place because the caller did not call UninstallBatch::confirm_untracked. Only uninstall_batch fills this.

§cancelled: Vec<String>

What was left undone because the caller cancelled.

install_batch_with lists each desired identifier not started, as given, and each Owner-Name of a started identifier’s dependency closure left uninstalled. uninstall_batch_with and set_enabled_batch_with list each identifier not started, and an uninstall also lists each confirmed untracked folder it did not remove, by path.

§re_enabled: Vec<String>

Recorded mods that were disabled before an install and are enabled after it, sorted. Only install_batch fills this, and leaves it empty when mods.yml cannot be read before or after the installs.

§kept_disabled: Vec<String>

Mods an install reinstalled and then restored to disabled, from InstallBatch::protect_disabled, sorted. Only install_batch fills this, and leaves it empty when mods.yml cannot be read after the installs.

Implementations§

Source§

impl BatchOutcome

Source

pub fn is_ok(&self) -> bool

Whether every item succeeded: nothing failed and nothing was cancelled.

Trait Implementations§

Source§

impl Clone for BatchOutcome

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 BatchOutcome

Source§

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

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

impl Default for BatchOutcome

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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