Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error { Workflow(WorkflowError), Task(TaskError), Client(ClientError), Worker(WorkerError), Actor(String), Network(String), Configuration(String), Serialization(String), Timeout(String), Io(Error), Other(String), }
Expand description

Main error type for the Orcher Rust SDK.

This enum, the per-area enums it wraps, and their variants with named fields are all #[non_exhaustive]: a new kind of error, or a new detail on an existing one, is not a breaking change. Match with a wildcard arm and .. in struct patterns, and build errors with the constructors such as TaskError::application or ClientError::workflow_not_found.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Workflow(WorkflowError)

Workflow execution error

§

Task(TaskError)

Task execution error

§

Client(ClientError)

Client operation error

§

Worker(WorkerError)

Worker error

§

Actor(String)

Actor operation error

§

Network(String)

Network/RPC error

§

Configuration(String)

Configuration error

§

Serialization(String)

Serialization/deserialization error

§

Timeout(String)

Timeout error

§

Io(Error)

I/O error

§

Other(String)

Generic error

Implementations§

Source§

impl Error

Source

pub fn is_suspend(&self) -> bool

Whether this is the workflow suspension signal rather than a real error.

Suspension is control flow: ctx.execute_task, ctx.execute and timers return WorkflowError::Suspended to hand control back to the runtime so it can schedule work and replay the workflow later. Combinators that inspect errors (sagas, select, retry wrappers) must propagate it unchanged and never treat it as a failed step.

Source

pub fn is_retryable(&self) -> bool

Whether this error is transient and may succeed on retry.

Examples are connection failures, timeouts, 5xx and 429 server responses, and task failures not marked non-retryable.

§Example
use orcher_sdk::error::{ClientError, Error};

let error = Error::Client(ClientError::server_error(503, "unavailable"));
assert!(error.is_retryable());

let error = Error::Client(ClientError::server_error(400, "bad request"));
assert!(!error.is_retryable());
Source

pub fn is_permanent(&self) -> bool

Whether this error is permanent, so retrying cannot fix it.

Examples are invalid configuration, authentication failures, non-determinism and 4xx server responses other than 429.

§Example
use orcher_sdk::error::{Error, TaskError};

let error: Error = TaskError::non_retryable("CardDeclined", "card declined").into();
assert!(error.is_permanent());

let error: Error = TaskError::application("Throttled", "slow down").into();
assert!(!error.is_permanent());
Source

pub fn with_context(self, context: impl Into<String>) -> Self

Wrap this error with a context message.

The result is an Error::Other whose message is "{context}: {self}", so the original variant is not preserved for matching.

§Example
use orcher_sdk::error::{Error, TaskError};

let error: Error = TaskError::execution_failed("card declined").into();
let error = error.with_context("Failed to execute payment task");
assert!(error.to_string().starts_with("Failed to execute payment task: "));
Source

pub fn code(&self) -> ErrorCode

The ErrorCode for this error, the same in every SDK.

Source

pub fn severity(&self) -> Severity

The Severity of this error, the same in every SDK.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<ClientError> for Error

Source§

fn from(source: ClientError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<TaskError> for Error

Source§

fn from(source: TaskError) -> Self

Converts to this type from the input type.
Source§

impl From<WorkerError> for Error

Source§

fn from(source: WorkerError) -> Self

Converts to this type from the input type.
Source§

impl From<WorkflowError> for Error

Source§

fn from(source: WorkflowError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Forget for Error

§

impl Freeze for Error

§

impl Move for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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