Module error

Expand description

Shared error types used across parsing, config loading, and formatting. Structured error types returned by parsing, config loading, and formatting.

Every fallible crate API returns Result, which is std::result::Result<T, Error>. The Error enum distinguishes sources:

Error::Parse — CMake source failed to parse; line/column info is 1-based.
Error::Config — a .cmakefmt.yaml|yml|toml (or from_yaml_str input) failed to deserialise, or a programmatic crate::Config had an invalid regex pattern.
Error::Spec — a commands: override file (or string) failed to deserialise, or the built-in spec file itself did.
Error::Io — filesystem or stream I/O failure.
Error::CliArg — a CLI argument validation failure (incompatible flag combinations, missing required arguments, conflicting overrides).
Error::InvalidRegex — a regex pattern from the user (CLI flag, config file, or spec override) failed to compile.
Error::Render — a failure rendering a Config or Spec to text (TOML / YAML / JSON), or building a machine-format report (SARIF / Checkstyle / JUnit / JSON edit).
Error::LegacyMigration — a failure during legacy cmake-format config migration.
Error::Formatter — miscellaneous higher-level formatter or CLI failure that does not fit any of the structured sub-variants above. Prefer Error::CliArg, Error::InvalidRegex, Error::Render, or Error::LegacyMigration when applicable.
Error::LayoutTooWide — only produced when crate::Config::require_valid_layout is enabled and a formatted line exceeded the configured width. Not a bug in the formatter — a signal to the caller.

crate::error::FileParseError and crate::error::ParseDiagnostic carry structured line/column metadata (1-based, both) so editor integrations can point at the offending source without re-parsing the error string.

Structs§

ConfigError: Stable config-file parse error returned by the public library API.
FileParseError: Structured config/spec deserialization failure metadata used for user-facing diagnostics.
ParseDiagnostic: Crate-owned parser diagnostics used by Error without exposing pest internals in the public API.
ParseError: Stable parse error returned by the public library API.
SpecError: Stable command-spec parse error returned by the public library API.

Error: Errors that can be returned by parsing, config loading, spec loading, or formatting operations.

IoResultExt: Extension trait for ergonomic conversion of io::Result<T> into the crate’s path-bearing Result<T>. Reads at call sites as std::fs::read_to_string(&path).with_path(&path)? — one extra token compared to .map_err(Error::Io)?, with much better diagnostics on failure.