Struct wallet_core::Error

pub struct Error {
    kind: ErrorKind,
    details: Option<Box<dyn Error + Send + Sync + 'static>>,
}

The error structure, contains details of what may have gone wrong

See the error’s kind for the high level information of what went wrong, it is also possible to then extract details (if any) of the error.

Fields

kind: ErrorKind

details: Option<Box<dyn Error + Send + Sync + 'static>>

Implementations

impl Error

pub fn kind(&self) -> &ErrorKind

access the error kind

pub fn details(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

if there are details return the pointer to the error type that triggered the error.

this is useful to display more details as to why an error occurred.

pub fn invalid_input(argument_name: &'static str) -> Self

construct a Result which is an error with invalid inputs

argument_name is expected to be a pointer to the parameter name.

example

fn example(pointer: *mut u8) -> Result {
  if pointer.is_null() {
    Error::invalid_input("pointer")
        .with(NulPointer)
        .into()
  } else {
    Result::success()
  }
}

let result = example(std::ptr::null_mut());

assert!(result.is_err());

pub fn wallet_recovering() -> Self

pub fn wallet_conversion() -> Self

pub fn wallet_vote_range() -> Self

pub fn wallet_transaction() -> Self

pub fn symmetric_cipher_error(err: Error) -> Self

pub fn invalid_vote_encryption_key() -> Self

pub fn not_enough_funds() -> Self

pub fn invalid_fragment() -> Self

pub fn invalid_transaction_validity_date() -> Self

pub fn invalid_spending_counters() -> Self

pub fn with<E>(self, details: E) -> Selfwhere E: Error + Send + Sync + 'static,

set some details to the Result object if the Result is of error kind

If the Result means success, then nothing is returned.

Example

fn example(pointer: *mut u8) -> Result {
  if pointer.is_null() {
    Error::invalid_input("pointer").into()
  } else {
    Result::success()
  }
}

let mut input = 2;
let input: *mut u8 = &mut 2;
let result = example(input).with(NulPointer);

assert!(result.is_ok());

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)>

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 From<Error> for Result

fn from(error: Error) -> Self

Converts to this type from the input type.