Struct CliError 

pub struct CliError {
    pub exit: Exit,
    pub message: String,
    pub hint: Option<String>,
    pub code: Option<ParalockErrorCode>,
    pub swap: Option<Box<Swap>>,
}

An error the CLI reports to the user: a message, an optional hint, the protocol code (if any) and the swap it concerns (if any).

Fields

exit: Exit

How the process exits.

message: String

What went wrong.

hint: Option<String>

What to do about it.

code: Option<ParalockErrorCode>

The Paralock error code, when the error came from the SDK or a maker.

swap: Option<Box<Swap>>

The swap, when it failed after its ZEC was locked.

Implementations

impl CliError

pub fn failed(message: impl Into<String>) -> Self

A runtime failure (exit 1).

pub fn usage(message: impl Into<String>) -> Self

A usage or configuration error (exit 2).

pub fn hint(self, hint: impl Into<String>) -> Self

Adds a hint.

pub fn context(self, what: impl Display) -> Self

Prefixes the message with what was being done.

Trait Implementations

impl Debug for CliError

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

Formats the value using the given formatter.

impl Display for CliError

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

Formats the value using the given formatter.

impl Error for CliError

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

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<StoreError> for CliError

fn from(e: StoreError) -> Self

Converts to this type from the input type.