Skip to main content

ErrorObject

Struct ErrorObject 

Source
pub struct ErrorObject {
    pub code: u16,
    pub class: u8,
    pub retryable: bool,
    pub fatal: bool,
    pub reason: String,
    pub details_cbor: ByteBuf,
}
Expand description

Wire-serialisable error object.

details_cbor carries opaque, structured details. Implementations MUST NOT place secret material or sensitive payload bytes into reason or details_cbor — error objects are forwarded across trust boundaries.

Fields§

§code: u16

Numeric error code (see gbp_core::errors::codes).

§class: u8

Error class as a u8 (see gbp_core::ErrorClass).

§retryable: bool

Whether the operation MAY be retried.

§fatal: bool

Whether the error is fatal (the node moves to FAILED).

§reason: String

Human-readable reason. MUST NOT carry secrets.

§details_cbor: ByteBuf

Structured detail bytes (typically CBOR).

Implementations§

Source§

impl ErrorObject

Source

pub fn from_spec(spec: ErrorSpec, reason: impl Into<String>) -> Self

Builds an error object from a registry ErrorSpec.

Source

pub fn new( code: u16, class: ErrorClass, retryable: bool, fatal: bool, reason: impl Into<String>, ) -> Self

Builds an error object with arbitrary fields (for codes outside the registry).

Source

pub fn to_cbor(&self) -> Vec<u8>

CBOR-encodes the error object.

Source

pub fn from_cbor(data: &[u8]) -> Result<Self, CodecError>

Decodes a CBOR-encoded error object.

Trait Implementations§

Source§

impl Clone for ErrorObject

Source§

fn clone(&self) -> ErrorObject

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 ErrorObject

Source§

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

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

impl<'de> Deserialize<'de> for ErrorObject

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ErrorObject

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,