Struct Error 

#[non_exhaustive]
pub struct Error {
    pub reason: String,
    pub error_uuid: String,
    pub message: String,
    pub error_time: Option<Timestamp>,
    pub details: HashMap<String, String>,
    /* private fields */
}

Represent a user-facing Error.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

reason: String

A title that explains the reason for the error.

error_uuid: String

A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

message: String

A message containing more information about the error that occurred.

error_time: Option<Timestamp>

The time when the error occurred.

details: HashMap<String, String>

Additional information about the error.

Implementations

impl Error

pub fn new() -> Self

pub fn set_reason<T: Into<String>>(self, v: T) -> Self

Sets the value of reason.

pub fn set_error_uuid<T: Into<String>>(self, v: T) -> Self

Sets the value of error_uuid.

pub fn set_message<T: Into<String>>(self, v: T) -> Self

Sets the value of message.

pub fn set_error_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of error_time.

pub fn set_or_clear_error_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of error_time.

pub fn set_details<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of details.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Default for Error

fn default() -> Error

Returns the “default value” for a type.

impl Message for Error

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error