Skip to main content

AttemptOutcome

Struct AttemptOutcome 

Source
pub struct AttemptOutcome { /* private fields */ }
Expand description

Semantic grouping of attempt result kind, optional error detail, and optional opaque handler output.

The result and error fields are semantically coupled: the error message is only meaningful in the context of its result kind. The output field is an opaque byte payload that successful handlers can use to return structured data to the dispatch loop / projection (e.g., ContextStore references).

Implementations§

Source§

impl AttemptOutcome

Source

pub fn success() -> Self

Creates a successful outcome with no error detail and no output.

Source

pub fn success_with_output(output: Vec<u8>) -> Self

Creates a successful outcome carrying opaque output bytes.

An empty vec is normalized to None (no output).

Source

pub fn failure(error: impl Into<String>) -> Self

Creates a failure outcome with an error message.

Source

pub fn timeout(error: impl Into<String>) -> Self

Creates a timeout outcome with an error message.

Source

pub fn suspended() -> Self

Creates a suspended outcome with no output.

Suspended attempts do not count toward the max_attempts retry cap.

Source

pub fn suspended_with_output(output: Vec<u8>) -> Self

Creates a suspended outcome carrying opaque partial-state bytes.

An empty vec is normalized to None (no output). The handler may use this to persist partial execution state for use when the run resumes.

Source

pub fn from_raw_parts( result: AttemptResultKind, error: Option<String>, output: Option<Vec<u8>>, ) -> Result<Self, AttemptOutcomeError>

Reconstructs an outcome from raw parts with semantic validation.

This is intended for WAL replay / deserialization paths where the result kind, error, and output are stored separately. Validates that:

  • Success / Suspended have error == None (output is optional)
  • Failure / Timeout have error == Some(_) and output == None
§Errors

Returns AttemptOutcomeError if the result kind and error do not satisfy the semantic coupling invariant.

Source

pub fn result(&self) -> AttemptResultKind

Returns the canonical attempt result kind.

Source

pub fn error(&self) -> Option<&str>

Returns the optional error detail.

Source

pub fn output(&self) -> Option<&[u8]>

Returns the optional opaque output bytes produced by the handler.

Source

pub fn into_parts(self) -> (AttemptResultKind, Option<String>, Option<Vec<u8>>)

Consumes the outcome, returning its parts for ownership transfer.

Trait Implementations§

Source§

impl Clone for AttemptOutcome

Source§

fn clone(&self) -> AttemptOutcome

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AttemptOutcome

Source§

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

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

impl PartialEq for AttemptOutcome

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for AttemptOutcome

Source§

impl StructuralPartialEq for AttemptOutcome

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.