Skip to main content

CallbackError

Struct CallbackError 

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

Common error information for prepare lifecycle callbacks.

This keeps a semantic callback type label together with the message so callers can classify failures without depending on fragile string matching.

§Examples

use qubit_dcl::double_checked::CallbackError;

let prepare_error = CallbackError::with_callback_type("prepare", "Resource is locked");
assert_eq!(prepare_error.callback_type(), Some("prepare"));
println!("prepare_error = {:?}", prepare_error);

Implementations§

Source§

impl CallbackError

Source

pub fn from_display<T: Display>(error: T) -> Self

Builds a callback error without type metadata.

§Type Parameters
  • T - Displayable error or message value to store.
§Parameters
  • error - Error value whose display text becomes this callback error’s message.
§Returns

A callback error with no callback type label.

Source

pub fn with_callback_type<T: Display>( callback_type: &'static str, error: T, ) -> Self

Builds a callback error with explicit callback type metadata.

§Parameters
  • callback_type - Semantic callback type label, such as "prepare" or "prepare_rollback".
  • error - Error message or displayable error value produced by the callback.
§Returns

A callback error with callback_type stored as metadata.

Source

pub fn message(&self) -> &str

Returns the raw message.

§Returns

The message captured from the original displayable error value.

Source

pub fn callback_type(&self) -> Option<&'static str>

Returns the callback type label, when available.

§Returns

Some(label) when this error was built with callback type metadata, or None when no metadata is available.

Source

pub fn is_typed(&self) -> bool

Returns whether the callback type label is set.

§Returns

true when Self::callback_type would return Some.

Trait Implementations§

Source§

impl Clone for CallbackError

Source§

fn clone(&self) -> CallbackError

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 CallbackError

Source§

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

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

impl Display for CallbackError

Source§

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

Formats this callback error for user-facing diagnostics.

§Parameters
  • f - Formatter receiving the formatted callback error.
§Returns

fmt::Result from writing the callback label and message.

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