Module error

Module error 

Source
Expand description

Error types for docs-md.

This module defines all errors that can occur during documentation generation. Errors use the miette crate for enhanced diagnostics, providing:

  • Human-readable error messages
  • Diagnostic codes for programmatic handling
  • Helpful suggestions for resolution

§Error Categories

  • I/O Errors (FileRead, CreateDir, FileWrite): File system operations
  • Parse Errors (JsonParse): Invalid or malformed rustdoc JSON
  • Lookup Errors (ItemNotFound): Missing items in the documentation index

Enums§

Error
Errors that can occur during documentation generation.