Skip to main content

ExecutionResult

Enum ExecutionResult 

Source
pub enum ExecutionResult<T, E> {
    Success(T),
    ConditionNotMet,
    Failed(ExecutorError<E>),
}
Expand description

Task execution result

Represents the result of executing a task using an enum to clearly distinguish between success, unmet conditions, and failure.

§Type Parameters

  • T - The type of the return value when execution succeeds
  • E - The type of the error when execution fails

§Examples

use qubit_dcl::double_checked::{ExecutionResult, ExecutorError};

let success: ExecutionResult<i32, String> = ExecutionResult::success(42);
if let ExecutionResult::Success(val) = success {
    println!("Value: {}", val);
}

let unmet: ExecutionResult<i32, String> = ExecutionResult::unmet();

let failed: ExecutionResult<i32, String> =
    ExecutionResult::task_failed("Task failed".to_string());

Variants§

§

Success(T)

Execution succeeded with a value

§

ConditionNotMet

Double-checked locking condition was not met

§

Failed(ExecutorError<E>)

Execution failed with an error

Implementations§

Source§

impl<T, E> ExecutionResult<T, E>

Source

pub fn success(value: T) -> Self

Builds ExecutionResult::Success with value.

§Parameters
  • value - Successful task value.
§Returns

A success result containing value.

Source

pub fn unmet() -> Self

Builds ExecutionResult::ConditionNotMet.

§Returns

A result representing a failed double-check condition.

Source

pub fn task_failed(err: E) -> Self

Builds a failed result with ExecutorError::TaskFailed.

§Parameters
  • err - Error returned by the executed task.
§Returns

A failed result wrapping the task error.

Source

pub fn prepare_failed(msg: impl Display) -> Self

Builds a failed result with ExecutorError::PrepareFailed.

Accepts any std::fmt::Display value (including std::error::Error and String); the message is stored in a CallbackError wrapper.

§Parameters
  • msg - Prepare error message or displayable error value.
§Returns

A failed result containing the prepare failure message.

Source

pub fn prepare_commit_failed(msg: impl Display) -> Self

Builds a failed result with ExecutorError::PrepareCommitFailed.

§Parameters
  • msg - Commit error message or displayable error value.
§Returns

A failed result containing the prepare-commit failure message.

Source

pub fn prepare_failed_with_type( callback_type: &'static str, msg: impl Display, ) -> Self

Builds a failed result with ExecutorError::PrepareFailed and explicit callback type metadata.

The callback type can later be read from ExecutorError::callback_type.

§Parameters
  • callback_type - Callback type tag, e.g. "prepare".
  • msg - Failure message.
Source

pub fn prepare_rollback_failed( original: impl Into<String>, rollback: impl Into<String>, ) -> Self

Builds a failed result with ExecutorError::PrepareRollbackFailed.

§Parameters
  • original - Original failure that triggered prepare rollback.
  • rollback - Failure produced by the rollback action.
§Returns

A failed result containing both original and rollback messages.

Source

pub fn from_executor_error(err: ExecutorError<E>) -> Self

Wraps an arbitrary ExecutorError as ExecutionResult::Failed.

§Parameters
  • err - Executor error to store in the failed result.
§Returns

A failed result containing err.

Source

pub fn is_success(&self) -> bool

Checks if the execution was successful.

§Returns

true if this result is ExecutionResult::Success.

Source

pub fn is_unmet(&self) -> bool

Checks if the condition was not met.

§Returns

true if this result is ExecutionResult::ConditionNotMet.

Source

pub fn is_failed(&self) -> bool

Checks if the execution failed.

§Returns

true if this result is ExecutionResult::Failed.

Source

pub fn into_result(self) -> Result<Option<T>, ExecutorError<E>>

Converts the result to a standard Result

§Returns
  • Ok(Some(T)) - If execution was successful
  • Ok(None) - If condition was not met
  • Err(ExecutorError<E>) - If execution failed
§Errors

Returns the stored ExecutorError when this value is ExecutionResult::Failed.

Source§

impl<T, E> ExecutionResult<T, E>
where E: Display,

Source

pub fn unwrap(self) -> T

Unwraps the success value, panicking if not successful

§Returns

The success value stored in ExecutionResult::Success.

§Panics

Panics if this result is ExecutionResult::ConditionNotMet or ExecutionResult::Failed.

Trait Implementations§

Source§

impl<T: Debug, E: Debug> Debug for ExecutionResult<T, E>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T, E> Freeze for ExecutionResult<T, E>
where T: Freeze, E: Freeze,

§

impl<T, E> RefUnwindSafe for ExecutionResult<T, E>

§

impl<T, E> Send for ExecutionResult<T, E>
where T: Send, E: Send,

§

impl<T, E> Sync for ExecutionResult<T, E>
where T: Sync, E: Sync,

§

impl<T, E> Unpin for ExecutionResult<T, E>
where T: Unpin, E: Unpin,

§

impl<T, E> UnsafeUnpin for ExecutionResult<T, E>
where T: UnsafeUnpin, E: UnsafeUnpin,

§

impl<T, E> UnwindSafe for ExecutionResult<T, E>
where T: UnwindSafe, E: UnwindSafe,

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