Skip to main content

Outcome

Struct Outcome 

Source
pub struct Outcome {
    pub disposition: Disposition,
    pub validity: Validity,
    pub reason: Option<String>,
    pub payload: Option<Arc<dyn Payload>>,
}
Expand description

SRD-82 Part 1 — the two-axis result of any execution shell, and the effect of an SRD-83 stop condition. The four meaningful quadrants: Completed+Succeeded (clean), Completed+Failed (ran fully, garbage), Interrupted+Succeeded (partial, re-usable), Interrupted+Failed (partial, discard).

PartialEq is hand-written (control facts only); Eq is dropped — see the impl PartialEq below.

Fields§

§disposition: Disposition§validity: Validity§reason: Option<String>

SRD-92 — optional human reason (the first failing child’s message), absorbing the parallel (Outcome, Option<String>) tuple the scenario shell carries today. None for clean outcomes; set via Outcome::with_reason. Dropping Copy (a String is not Copy) is the cost — by-value reuses become moves/clones. Serialized only when present, so axis-only Outcome JSON round-trips unchanged.

§payload: Option<Arc<dyn Payload>>

SRD-92 / ExecUnification — the optional opaque return payload a unit may carry above the leaf-projection boundary (the op leaf fills it via Outcome::with_payload; aggregates leave it None). Arc (not Box) so Outcome stays Clone; #[serde(skip)] because it is runtime-only, so axis-only JSON round-trips unchanged. Excluded from PartialEq — it is data, not control identity. Its contents are the deferred data layer.

Implementations§

Source§

impl Outcome

Source

pub const fn new(disposition: Disposition, validity: Validity) -> Self

Source

pub const fn completed() -> Self

Ran fully, result trustworthy.

Source

pub const fn failed() -> Self

Stopped early, result untrustworthy — the SRD-83 fail effect / a StopCause::Fault.

Source

pub const fn completed_failed() -> Self

SRD-92 — ran fully but the result is untrustworthy (a ran-and-errored op): Completed+Failed. Distinct from Outcome::failed (Interrupted+Failed — stopped early by a fault).

Source

pub const fn interrupted() -> Self

Stopped early, partial result usable — the SRD-83 stop effect / a StopCause::Interrupt (e.g. user Ctrl-C, budget met).

Source

pub const fn skipped() -> Self

Never started.

Source

pub fn with_reason(self, reason: impl Into<String>) -> Self

SRD-92 — attach the human reason (the failing child’s message). Used by the flow-Outcome-up step so the leaf shells / aggregate fold carry the message that the ?-propagation path needs, retiring the parallel (Outcome, Option<String>) tuple.

Source

pub fn is_failure(&self) -> bool

Binary pass/fail projection for session-level counting: the only red mark is an untrustworthy result. Interrupted + Succeeded (Ctrl-C, budget met, cursor-suspend) and Skipped are non-failures from the operator’s perspective.

Source

pub fn glyph(&self) -> char

Glyph for compact rendering. One per meaningful axis pair (SRD-82 Part 1): ✓ ran-and-trustworthy, ✗ untrustworthy (whether it ran fully or not), … re-usable partial progress, ~ never started, ⋯ still in flight.

Source

pub fn label(&self) -> &'static str

All-lowercase short label, stable for log lines / CI greps / the sqlite status column. The axes yield five terminal labels; interrupted subsumes the retired cursor_suspended (a resume cursor on the outcome carries the resumability signal — SRD-82 Part 1).

Source

pub fn with_payload(self, payload: Arc<dyn Payload>) -> Self

SRD-92 / ExecUnification — attach the opaque return Payload (the op leaf’s body, lifted at the projection boundary in a later step). Aggregates never call this — the payload rides the leaf’s Outcome and is ignored by the fold.

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<'de> Deserialize<'de> for Outcome

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

SRD-92 / ExecUnification — equality over the CONTROL FACTS only (disposition, validity, reason). The payload is intentionally excluded: it is data, not control identity, so two outcomes that differ only in their payload compare equal. Do NOT “fix” this to compare payloads — dyn Payload is not PartialEq, and aggregation / tests key on control facts, never the payload. (Eq is dropped: it is unused — no HashSet/HashMap<Outcome> exists — and a dyn field can’t satisfy it.)

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 Outcome

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

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> 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> 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