Skip to main content

ItemOutcome

Enum ItemOutcome 

Source
pub enum ItemOutcome {
    Succeeded,
    Failed(String),
    Quarantined(String),
    Suspended(String),
    Exhausted(String),
    Withheld(String),
}
Expand description

How one item ended.

Mirrors RunStatus but deliberately coarser: a batch’s census is about what a human must do next, and “failed” and “exhausted” both mean this item did not settle. The item’s own run journal holds the detail.

Variants§

§

Succeeded

§

Failed(String)

Ran and did not settle — a failure, or a limit.

§

Quarantined(String)

Set aside for a human. Distinct from failed because the response is different: a failed item may be re-run, a quarantined one must not be touched until someone has looked at it.

§

Suspended(String)

Waiting on something — an event, a person, a timer.

Not terminal. A batch that suspends items is not finished, and counting a suspension as a failure would send someone to investigate a run that is working exactly as designed.

§

Exhausted(String)

Paused at a ceiling. Not terminal, and deliberately not Failed: the item’s run is intact and stays open — an operator’s two honest moves are raise the ceiling and resume, or cancel — and a pause reported as a fault teaches the reader to re-run work that is standing. The string names the ceiling that was hit.

§

Withheld(String)

Paused because an authority the item acts under was withdrawn. Not terminal, and not Exhausted: the work stands as it does at a ceiling, but the move is lifting the halt on that subject rather than raising a budget. The string names the subject and why it was withdrawn.

Implementations§

Source§

impl ItemOutcome

Source

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

Source

pub fn all(detail: String) -> [Self; 6]

Every outcome, each carrying detail.

The list parse is written over, and the list a store derives its terminal set from — so a query asking what is still open answers from the type rather than from a list of strings beside it.

Source

pub fn parse(tag: &str, detail: String) -> Option<Self>

The inverse of as_str, written over all for the reason CaseStatus::parse is.

None is damage rather than absence: an item whose outcome cannot be read has not failed to run, and a census filing it as in-flight keeps the batch Running forever over a row nobody can explain.

Source

pub const fn is_terminal(&self) -> bool

Source

pub fn terminal_tags() -> Vec<&'static str>

The stored spellings of every outcome that ends an item.

What a store asks for when it wants the complement: an item is open while it has no outcome or an outcome outside this set, so a non-terminal variant added later is open by construction rather than by somebody remembering to widen a list of strings.

Source

pub const fn is_settled(&self) -> bool

Whether this item is finished and needs nothing from anybody.

Terminal and settled are different questions, and the difference is the backlog: Failed and Quarantined are terminal and are exactly what a person has to see. Written as a match rather than == Succeeded so a variant added later is unsettled by construction — the safe direction.

Source

pub fn settled_tags() -> Vec<&'static str>

The stored spellings of every outcome nobody has to act on.

The set a store negates to build items_needing_attention. Derived from all for the reason terminal_tags is: a hand-kept list of strings stops naming a class of trouble the day somebody adds one.

Trait Implementations§

Source§

impl Clone for ItemOutcome

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 ItemOutcome

Source§

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

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

impl<'de> Deserialize<'de> for ItemOutcome

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ItemOutcome

Source§

impl PartialEq for ItemOutcome

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 Serialize for ItemOutcome

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ItemOutcome

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> MaybeSend for T
where T: Send,

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