Struct Error

pub struct Error { /* private fields */ }

Represents an error that took place when calling a Catenis API client function.

That error can be of two different types:

Client error

An error that takes place in the client itself, and could be of many different kinds.

Catenis API error

A response returned by the Catenis API server reporting an error condition while processing the client request.

Example

// Simulate a Catenis API error trying to read a message with an invalid message ID
let error = ctn_client.read_message("xxxxx", None).err().unwrap();

assert!(error.is_api_error());

let api_error = error.api_error_info().unwrap();

assert_eq!(api_error.status_code(), 400);
assert_eq!(api_error.status_message().unwrap(), "Bad Request");
assert_eq!(api_error.catenis_message().unwrap(), "[400] - Invalid message ID");

assert_eq!(error.to_string(), "Catenis API error: [400] - Invalid message ID");

Implementations

impl Error

pub fn is_api_error(&self) -> bool

Indicates whether this is a Catenis API error.

pub fn api_error_info(&self) -> Option<&ApiErrorInfo>

Retrieves information about the Catenis API error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl<E> From<E> for Error

where E: ConvertibleError + Into<Box<dyn Error + Send + Sync>>,

fn from(err: E) -> Error

Converts to this type from the input type.