Enum Error

pub enum Error {
    Unexpected(Error),
    User(Error),
    Help {
        command: Vec<String>,
        output: String,
        code: i32,
    },
    Config(Error),
    ExitWithCode(i32),
}

A top level error type for ffx tool results

Variants

Unexpected(Error)

An error that qualifies as a bugcheck

User(Error)

A known kind of error that can be reported usefully to the user

Help

An early-exit that should result in outputting help to the user (like [argh::EarlyExit]), but is not itself an error in any meaningful sense.

Fields

command: Vec<String>

The command name (argv[0..]) that should be used in supplemental help output

output: String

The text to output to the user

code: i32

The exit status

Config(Error)

Something failed before ffx’s configuration could be loaded (like an invalid argument, a failure to read an env config file, etc).

Errors of this type should include any information the user might need to recover from the issue, because it will not advise the user to look in the log files or anything like that.

ExitWithCode(i32)

Exit with a specific error code but no output

Implementations

impl Error

pub fn downcast_non_fatal(self) -> Result<Error, Self>

Attempts to downcast this error into something non-fatal, returning Ok(e) if able to downcast to something non-fatal, else returning the original error.

impl Error

pub fn from_early_exit( command: &[impl AsRef<str>], early_exit: EarlyExit, ) -> Self

Map an argh early exit to our kind of error

pub fn exit_code(&self) -> i32

Get the exit code this error should correspond to if it bubbles up to main()

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

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<FfxError> for Error

fn from(error: FfxError) -> Self

Converts to this type from the input type.

impl IntoExitCode for Error

fn exit_code(&self) -> i32

impl ResultExt for Error

fn ffx_error<'a>(&'a self) -> Option<&'a FfxError>