Expand description
Pluggable error-code catalog.
quarto-error-reporting is catalog-agnostic: it defines the catalog
shape (ErrorCodeInfo) and a CatalogProvider seam, but ships no
catalog data. An embedding product installs its own catalog once, early,
via install_catalog; in Quarto this is done by the quarto-error-catalog
crate (quarto_error_catalog::install()), which carries the Q-*
error_catalog.json. With nothing installed, every lookup returns None
(see EmptyCatalog).
This is the host side of the cross-package error-code discipline; see
claude-notes/designs/cross-package-error-codes.md.
Structs§
- Empty
Catalog - The default provider used when none has been installed: every lookup is
None. This is what makes the crate usable standalone with zero config — a non-Quarto consumer that installs nothing simply gets code-less, URL-less diagnostics (tier-2 “passthrough” in the discipline’s terms). - Error
Code Info - Metadata for an error code.
Traits§
- Catalog
Provider - A source of error-code metadata, supplied by the embedding product.
Functions§
- get_
docs_ url - Get the documentation URL for an error code, if the installed catalog has one.
- get_
error_ info - Look up full metadata for an error code via the installed catalog.
- get_
subsystem - Get the subsystem name for an error code, if the installed catalog knows it.
- install_
catalog - Install the process-wide catalog provider.