Struct VibeEngineError 

pub struct VibeEngineError { /* private fields */ }

Error type returned by vibe-ready operations. Error returned by vibe-ready operations.

Implementations

impl VibeEngineError

pub fn code(&self) -> i32

Returns the numeric error code.

Returns

The stable i32 code associated with this error.

pub fn kind(&self) -> VibeErrorKind

Returns the high-level error category.

Returns

A VibeErrorKind derived from the numeric code.

pub fn message(&self) -> &str

Returns the human-readable error message.

Returns

A borrowed message string.

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

Returns the optional source message.

Returns

Some(&str) when a lower-level source was attached.

pub fn context(&self) -> &[String]

Returns contextual breadcrumbs attached to the error.

Returns

A borrowed slice of context strings.

pub fn with_source(self, source: impl Into<String>) -> Self

Attaches a source message to this error.

Returns

The updated error value.

Examples

use vibe_ready::{VibeEngineError, VibeErrorCode};

let error = VibeEngineError::from_error_code(VibeErrorCode::RuntimeError)
    .with_source("worker stopped");
assert_eq!(error.source_message(), Some("worker stopped"));

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

Adds contextual information to this error.

Returns

The updated error value.

pub fn from_success() -> Self

Creates the canonical success value.

Returns

A VibeEngineError whose code is VibeEngineErrorCode::Success.

pub fn from_u16(code: u16) -> Self

Creates an error from an unsigned 16-bit raw code.

Returns

A raw-code error with VibeErrorKind::Unknown.

pub fn from_u32(code: u32) -> Self

Creates an error from an unsigned 32-bit raw code.

Returns

A raw-code error with VibeErrorKind::Unknown.

pub fn is_success(&self) -> bool

Checks whether this error represents success.

Returns

true when the code is VibeEngineErrorCode::Success.

pub fn same_code(&self) -> Self

Clones this error while preserving the same code and context.

Returns

A clone of this error.

pub fn from_error_code(value: VibeEngineErrorCode) -> Self

Creates an error from a stable code variant.

Returns

A VibeEngineError with default kind and message for the code.

pub fn from_code(value: VibeEngineErrorCode) -> Self

Creates an error from a stable code variant.

Returns

A VibeEngineError with default kind and message for the code.

pub fn from_error_code_msg(value: VibeEngineErrorCode, msg: String) -> Self

Creates an error from a code variant and custom message.

Returns

A VibeEngineError using msg as the display message.

pub fn from_task_interruption_error() -> Self

Creates the standard task-interruption error.

Returns

A VibeEngineError with VibeEngineErrorCode::TaskInterruptionError.

pub fn from_internal_error() -> Self

Creates the standard internal error.

Returns

A VibeEngineError with VibeEngineErrorCode::InternalError.

pub fn from_mpsc_send_error() -> Self

Creates the standard MPSC send error.

Returns

A VibeEngineError with VibeEngineErrorCode::MPSCSendError.

pub fn from_parameter_empty() -> Self

Creates the standard empty-parameter error.

Returns

A VibeEngineError with VibeEngineErrorCode::ParameterEmpty.

pub fn from_parameter_empty_log(tag: &str) -> Self

Logs and creates the standard empty-parameter error.

Returns

A VibeEngineError with VibeEngineErrorCode::ParameterEmpty.

Trait Implementations

impl Clone for VibeEngineError

fn clone(&self) -> VibeEngineError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VibeEngineError

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

Formats the value using the given formatter.

impl Display for VibeEngineError

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

Formats the value using the given formatter.

impl Error for VibeEngineError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<DbError> for VibeEngineError

fn from(err: DbError) -> Self

Converts to this type from the input type.

impl Serialize for VibeEngineError

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.