Struct CommandRegistry 

pub struct CommandRegistry { /* private fields */ }

Registry of known CMake command specifications used to guide formatting.

The registry describes the argument structure of each command — positional slots, keyword sections, flags, and per-form layout hints — so the formatter can group and wrap arguments correctly.

Two-tier model

The built-in registry covers the full CMake standard library. User override files (TOML or YAML) can extend or modify any entry without replacing the whole registry.

Getting a registry

Situation	Recommended call
No customisation needed	CommandRegistry::builtins — lazily initialised singleton, cheapest
Fresh owned copy	CommandRegistry::load — allocates every call
Merge with user override file	CommandRegistry::from_builtins_and_overrides

Implementations

impl CommandRegistry

pub fn load() -> Result<Self>

Load the embedded built-in registry from builtins.toml.

Returns a fresh owned CommandRegistry on every call. Prefer CommandRegistry::builtins when you only need a read-only reference — it initialises once and amortises the parse cost across all callers.

pub fn builtins() -> &'static Self

Return the lazily initialised built-in registry singleton.

The registry is parsed exactly once on first call; subsequent calls return a &'static reference at zero cost. Use CommandRegistry::load if you need an owned, mutable copy.

pub fn from_builtins_and_overrides( path: Option<impl AsRef<Path>>, ) -> Result<Self>

Load the embedded built-ins and optionally merge a user override file.

pub fn merge_toml_overrides(&mut self, toml_source: &str) -> Result<()>

Merge TOML-formatted command spec overrides from a string.

pub fn merge_yaml_overrides(&mut self, yaml_source: &str) -> Result<()>

Merge YAML-formatted command spec overrides from a string.

pub fn merge_override_file(&mut self, path: &Path) -> Result<()>

Merge a supported user override file from disk into the registry.

pub fn merge_override_str( &mut self, source: &str, path: impl Into<PathBuf>, ) -> Result<()>

Merge TOML override contents into the registry.

pub fn get(&self, command_name: &str) -> &CommandSpec

Get the command spec for command_name, falling back to a permissive default when the command is unknown.

pub fn contains_builtin(&self, command_name: &str) -> bool

Return true when the command is present in the built-in registry.

pub fn audited_cmake_version(&self) -> &str

Report the audited upstream CMake version for the built-in spec.

Trait Implementations

impl Clone for CommandRegistry

fn clone(&self) -> CommandRegistry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandRegistry

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

Formats the value using the given formatter.