Enum CliError 

pub enum CliError {
    Clap(Error),
    Usage(String),
    StartIcp(Error),
    Icp {
        status: String,
        message: String,
    },
    Encode {
        method: &'static str,
        source: Error,
    },
    Decode {
        method: &'static str,
        source: Error,
    },
    RawReply(&'static str),
    ArgumentFile(Error),
    Canister {
        method: &'static str,
        error: String,
    },
    ProviderCard {
        provider: &'static str,
        set_id: String,
        offset: u64,
        source: Box<Self>,
    },
    ProviderReplay {
        provider: String,
        kind: &'static str,
        set: String,
        first_record: usize,
        last_record: usize,
        source: Box<Self>,
    },
    Json(Error),
    Io(Error),
    CacheIo {
        action: &'static str,
        path: PathBuf,
        source: Error,
    },
    BackupIo {
        action: &'static str,
        path: PathBuf,
        source: Error,
    },
    InvalidCache(String),
    PaginationStalled(String),
    PaginationLimit(usize),
}

Failure reported by CLI parsing, the ICP process boundary, or the typed canister protocol.

Variants

Clap(Error)

Clap rejected the command line before any canister call was attempted.

Usage(String)

Command-line arguments did not describe a valid operation.

StartIcp(Error)

The ICP CLI process could not be started.

Icp

The ICP CLI process reported a failed call.

Fields

status: String

Numeric process exit status, when the platform supplied one.

message: String

Bounded diagnostic written by the ICP CLI.

Encode

Typed Candid argument encoding failed before the process was started.

Fields

method: &'static str

Canister method being prepared.

source: Error

Candid codec failure.

Decode

The canister reply was not valid for the shared interface type.

Fields

method: &'static str

Canister method whose reply was being decoded.

source: Error

Candid codec failure.

RawReply(&'static str)

The ICP CLI returned something other than one bounded hexadecimal reply.

ArgumentFile(Error)

A temporary binary Candid argument file could not be prepared.

Canister

A typed application error was returned by the canister.

Fields

method: &'static str

Called canister method.

error: String

Credential-free bounded application error.

ProviderCard

A provider-set card acquisition failed after earlier cards were checkpointed successfully.

Fields

provider: &'static str

Provider adapter being acquired.

set_id: String

Provider-owned set identifier.

offset: u64

Zero-based card position in the provider set index.

source: Box<Self>

Bounded canister or transport failure.

ProviderReplay

Replaying a bounded group of retained provider records failed.

Fields

provider: String

Provider adapter represented by the retained records.

kind: &'static str

Human-readable cache partition kind.

set: String

Optional provider-owned set context.

first_record: usize

One-based first record position in this cache partition.

last_record: usize

One-based last record position in this cache partition.

source: Box<Self>

Bounded canister or transport failure.

Json(Error)

JSON input or output could not be decoded or encoded.

Io(Error)

Writing the final report failed.

CacheIo

Reading or atomically replacing a provider cache failed.

Fields

action: &'static str

Filesystem operation being attempted.

path: PathBuf

Cache artifact path.

source: Error

Underlying filesystem failure.

BackupIo

Writing a canonical JSON backup failed.

Fields

action: &'static str

Filesystem operation being attempted.

path: PathBuf

Backup path involved in the failed operation.

source: Error

Underlying filesystem failure.

InvalidCache(String)

A provider cache did not satisfy its bounded format contract.

PaginationStalled(String)

A canister returned a continuation that had already been observed.

PaginationLimit(usize)

Automatic pagination reached its operator-provided safety bound.

Implementations

impl CliError

pub fn exit_code(&self) -> i32

Shell exit status for this failure category.

pub fn is_broken_pipe(&self) -> bool

Whether a downstream pipeline closed standard output intentionally.

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, __formatter: &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(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(source: Error) -> Self

Converts to this type from the input type.