Enum CommandError 

pub enum CommandError {
    Create(Box<CreateCommandError>),
    Destroy(Box<DestroySubcommandError>),
    Docs(Box<DocsCommandError>),
    Provision(Box<ProvisionSubcommandError>),
    Configure(Box<ConfigureSubcommandError>),
    Test(Box<TestSubcommandError>),
    Register(Box<RegisterSubcommandError>),
    Release(Box<ReleaseSubcommandError>),
    Render(Box<RenderCommandError>),
    Run(Box<RunSubcommandError>),
    Show(Box<ShowSubcommandError>),
    Exists(Box<ExistsSubcommandError>),
    List(Box<ListSubcommandError>),
    Purge(Box<PurgeSubcommandError>),
    Validate(Box<ValidateSubcommandError>),
    UserOutputLockFailed,
}

Errors that can occur during CLI command execution

This enum provides a unified interface for all command-specific errors, following the project’s error handling conventions with structured error types, source preservation, and tiered help system support.

Variants

Create(Box<CreateCommandError>)

Create command specific errors

Encapsulates all errors that can occur during create operations (environment or template). Use .help() for detailed troubleshooting steps.

Destroy(Box<DestroySubcommandError>)

Destroy command specific errors

Encapsulates all errors that can occur during environment destruction. Use .help() for detailed troubleshooting steps.

Docs(Box<DocsCommandError>)

Docs command specific errors

Encapsulates all errors that can occur during CLI documentation generation. Use .help() for detailed troubleshooting steps.

Provision(Box<ProvisionSubcommandError>)

Provision command specific errors

Encapsulates all errors that can occur during infrastructure provisioning. Use .help() for detailed troubleshooting steps.

Configure(Box<ConfigureSubcommandError>)

Configure command specific errors

Encapsulates all errors that can occur during environment configuration. Use .help() for detailed troubleshooting steps.

Test(Box<TestSubcommandError>)

Test command specific errors

Encapsulates all errors that can occur during infrastructure validation. Use .help() for detailed troubleshooting steps.

Register(Box<RegisterSubcommandError>)

Register command specific errors

Encapsulates all errors that can occur during instance registration. Use .help() for detailed troubleshooting steps.

Release(Box<ReleaseSubcommandError>)

Release command specific errors

Encapsulates all errors that can occur during software release operations. Use .help() for detailed troubleshooting steps.

Render(Box<RenderCommandError>)

Render command specific errors

Encapsulates all errors that can occur during artifact generation. Use .help() for detailed troubleshooting steps.

Run(Box<RunSubcommandError>)

Run command specific errors

Encapsulates all errors that can occur during stack execution. Use .help() for detailed troubleshooting steps.

Show(Box<ShowSubcommandError>)

Show command specific errors

Encapsulates all errors that can occur during environment information display. Use .help() for detailed troubleshooting steps.

Exists(Box<ExistsSubcommandError>)

Exists command specific errors

Encapsulates all errors that can occur during environment existence check. Use .help() for detailed troubleshooting steps.

List(Box<ListSubcommandError>)

List command specific errors

Encapsulates all errors that can occur during environment listing. Use .help() for detailed troubleshooting steps.

Purge(Box<PurgeSubcommandError>)

Purge command specific errors

Encapsulates all errors that can occur during local environment data removal. Use .help() for detailed troubleshooting steps.

Validate(Box<ValidateSubcommandError>)

Validate command specific errors

Encapsulates all errors that can occur during configuration validation. Use .help() for detailed troubleshooting steps.

UserOutputLockFailed

User output lock acquisition failed

Failed to acquire the mutex lock for user output. This typically indicates a panic occurred in another thread while holding the lock.

Implementations

impl CommandError

pub fn help(&self) -> String

Get detailed troubleshooting guidance for this error

This method provides comprehensive troubleshooting steps that can be displayed to users when they need more help resolving the error. It delegates to the specific command error’s help method.

Example

use clap::Parser;
use torrust_tracker_deployer_lib::presentation::cli::errors;
use torrust_tracker_deployer_lib::presentation::cli::controllers::destroy::DestroySubcommandError;
use torrust_tracker_deployer_lib::application::command_handlers::destroy::DestroyCommandHandlerError;
use std::path::PathBuf;

// Create error for demonstration
let destroy_error = DestroySubcommandError::DestroyOperationFailed {
    name: "test-env".to_string(),
    source: DestroyCommandHandlerError::StateCleanupFailed {
        path: PathBuf::from("/tmp/test"),
        source: std::io::Error::new(std::io::ErrorKind::PermissionDenied, "access denied"),
    },
};
let error = errors::CommandError::Destroy(Box::new(destroy_error));

// Get help text
let help_text = error.help();
println!("{}", help_text);

Trait Implementations

impl Debug for CommandError

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

Formats the value using the given formatter.

impl Display for CommandError

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

Formats the value using the given formatter.

impl Error for CommandError

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<ConfigureSubcommandError> for CommandError

fn from(error: ConfigureSubcommandError) -> Self

Converts to this type from the input type.

impl From<CreateCommandError> for CommandError

fn from(error: CreateCommandError) -> Self

Converts to this type from the input type.

impl From<DestroySubcommandError> for CommandError

fn from(error: DestroySubcommandError) -> Self

Converts to this type from the input type.

impl From<DocsCommandError> for CommandError

fn from(error: DocsCommandError) -> Self

Converts to this type from the input type.

impl From<ExistsSubcommandError> for CommandError

fn from(error: ExistsSubcommandError) -> Self

Converts to this type from the input type.

impl From<ListSubcommandError> for CommandError

fn from(error: ListSubcommandError) -> Self

Converts to this type from the input type.

impl From<ProvisionSubcommandError> for CommandError

fn from(error: ProvisionSubcommandError) -> Self

Converts to this type from the input type.

impl From<PurgeSubcommandError> for CommandError

fn from(error: PurgeSubcommandError) -> Self

Converts to this type from the input type.

impl From<RegisterSubcommandError> for CommandError

fn from(error: RegisterSubcommandError) -> Self

Converts to this type from the input type.

impl From<ReleaseSubcommandError> for CommandError

fn from(error: ReleaseSubcommandError) -> Self

Converts to this type from the input type.

impl From<RenderCommandError> for CommandError

fn from(error: RenderCommandError) -> Self

Converts to this type from the input type.

impl From<RunSubcommandError> for CommandError

fn from(error: RunSubcommandError) -> Self

Converts to this type from the input type.

impl From<ShowSubcommandError> for CommandError

fn from(error: ShowSubcommandError) -> Self

Converts to this type from the input type.

impl From<TestSubcommandError> for CommandError

fn from(error: TestSubcommandError) -> Self

Converts to this type from the input type.

impl From<ValidateSubcommandError> for CommandError

fn from(error: ValidateSubcommandError) -> Self

Converts to this type from the input type.