Enum DocsCommandError 

pub enum DocsCommandError {
    SchemaGenerationFailed {
        source: CliDocsGenerationError,
    },
    DirectoryCreationFailed {
        path: PathBuf,
        source: Error,
    },
    FileWriteFailed {
        path: PathBuf,
        source: Error,
    },
    ProgressReporterFailed {
        source: ProgressReporterError,
    },
}

Errors that can occur during CLI documentation creation in the presentation layer

Variants

SchemaGenerationFailed

CLI documentation generation failed (infrastructure layer)

Fields

source: CliDocsGenerationError

The underlying infrastructure error

DirectoryCreationFailed

Failed to create parent directory for documentation file

Fields

path: PathBuf

Path that couldn’t be created

source: Error

The underlying I/O error

FileWriteFailed

Failed to write documentation file

Fields

path: PathBuf

Path that couldn’t be written

source: Error

The underlying I/O error

ProgressReporterFailed

Progress reporter error

Fields

source: ProgressReporterError

The underlying progress reporter error

Implementations

impl DocsCommandError

pub fn help(&self) -> String

Returns actionable help text for resolving this error

Trait Implementations

impl Debug for DocsCommandError

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

Formats the value using the given formatter.

impl Display for DocsCommandError

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

Formats the value using the given formatter.

impl Error for DocsCommandError

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

fn from(error: DocsCommandError) -> Self

Converts to this type from the input type.

impl From<ProgressReporterError> for DocsCommandError

fn from(source: ProgressReporterError) -> Self

Converts to this type from the input type.