Skip to main content

ErrorDescriptor

Struct ErrorDescriptor 

Source
pub struct ErrorDescriptor {
    pub name: &'static str,
    pub code: u32,
    pub invariant: &'static str,
    pub doc: &'static str,
}
Expand description

Descriptor for one variant of a #[hopper::error] enum.

Carried in the program manifest so off-chain SDKs can map numeric error codes back to names and. via invariant. to the safety check that produced them.

§Design notes

Hopper errors can carry the invariant name a variant corresponds to, so a client that sees error 0x1001 can surface “Invariant balance_nonzero failed” without needing to keep a separate lookup table in sync with the on-chain code.

Fields§

§name: &'static str

Variant name (exactly as declared).

§code: u32

Stable numeric code emitted on failure.

§invariant: &'static str

Invariant this error corresponds to, or empty string if none.

§doc: &'static str

Short documentation string (often copied from variant doc comments).

Trait Implementations§

Source§

impl Clone for ErrorDescriptor

Source§

fn clone(&self) -> ErrorDescriptor

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 ErrorDescriptor

Source§

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

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

impl PartialEq for ErrorDescriptor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Copy for ErrorDescriptor

Source§

impl Eq for ErrorDescriptor

Source§

impl StructuralPartialEq for ErrorDescriptor

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.