Struct conjure_error::serializable_error::SerializableError

pub struct SerializableError { /* fields omitted */ }

The JSON-serializable representation of an error.

Methods

impl SerializableError

pub fn builder() -> Builder

Returns a new builder.

pub fn error_code(&self) -> &ErrorCode

The broad category of the error.

When transmitted over HTTP, this determines the response's status code.

pub fn error_name(&self) -> &str

The error's name.

The name is made up of a namespace and more specific error name, separated by a :.

pub fn error_instance_id(&self) -> Uuid

A unique identifier for this error instance.

This can be used to correlate reporting about the error as it transfers between components of a distributed system.

pub fn parameters(&self) -> &BTreeMap<String, String>

Parameters providing more information about the error.

Trait Implementations

impl ErrorType for SerializableError

fn code(&self) -> ErrorCode

Returns the error's code.

fn name(&self) -> &str

Returns the error's name.

fn instance_id(&self) -> Option<Uuid>

Returns the error's instance ID, if it stores one.

fn safe_args(&self) -> &'static [&'static str]

Returns a sorted slice of the names of the error's safe parameters.

fn with_instance_id(self, instance_id: Uuid) -> WithInstanceId<Self> where
    Self: Sized, 

Wraps the error in another that overrides its instance ID.

impl PartialEq<SerializableError> for SerializableError

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SerializableError) -> bool

This method tests for !=.

impl From<SerializableError> for Builder

fn from(_v: SerializableError) -> Builder

Performs the conversion.

impl Clone for SerializableError

fn clone(&self) -> SerializableError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for SerializableError

fn cmp(&self, other: &SerializableError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for SerializableError

impl PartialOrd<SerializableError> for SerializableError

fn partial_cmp(&self, other: &SerializableError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SerializableError) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SerializableError) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SerializableError) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SerializableError) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for SerializableError

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

Formats the value using the given formatter.

impl Hash for SerializableError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'de> Deserialize<'de> for SerializableError

fn deserialize<D>(d: D) -> Result<SerializableError, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for SerializableError

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

Serialize this value into the given Serde serializer.