Enum CliDocsGenerationError 

pub enum CliDocsGenerationError {
    SerializationFailed {
        source: Error,
    },
}

Errors that can occur during CLI documentation generation

Variants

SerializationFailed

Failed to serialize documentation to JSON

Fields

source: Error

The underlying serialization error

Implementations

impl CliDocsGenerationError

pub fn help(&self) -> String

Returns actionable help text for resolving this error

Following the project’s tiered help system pattern.

Trait Implementations

impl Debug for CliDocsGenerationError

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

Formats the value using the given formatter.

impl Display for CliDocsGenerationError

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

Formats the value using the given formatter.

impl Error for CliDocsGenerationError

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.