Struct PluginRegistry 

pub struct PluginRegistry { /* private fields */ }

A registry for managing both built-in and custom rules.

This registry reuses the static rule registry for built-in rules, avoiding duplication. Custom rules are stored separately and can override built-in rules with the same ID.

Example

use cargo_perf::plugin::PluginRegistry;

let mut registry = PluginRegistry::new();
registry.add_builtin_rules();
registry.add_rule(Box::new(MyCustomRule));

Implementations

impl PluginRegistry

pub fn new() -> Self

Create an empty plugin registry.

pub fn add_builtin_rules(&mut self)

Add all built-in rules to the registry.

This references the static rule registry rather than creating new instances, avoiding memory duplication.

pub fn add_rule(&mut self, rule: Box<dyn Rule>)

Add a custom rule to the registry.

Panics

Panics if a rule with the same ID already exists. Use try_add_rule for a non-panicking version or add_or_replace_rule to replace existing rules.

pub fn try_add_rule(&mut self, rule: Box<dyn Rule>) -> Result<(), Box<dyn Rule>>

Try to add a custom rule to the registry.

Returns an error if a rule with the same ID already exists in custom rules. Note: This allows overriding built-in rules with custom implementations. Use add_or_replace_rule to replace existing rules without error.

Errors

Returns Err with the rejected rule if a custom rule with the same ID already exists.

pub fn add_or_replace_rule(&mut self, rule: Box<dyn Rule>)

Add a custom rule, replacing any existing custom rule with the same ID.

pub fn rules(&self) -> Vec<&dyn Rule>

Get all registered rules as trait object references.

Returns an iterator over all rules (built-in + custom). Custom rules with the same ID as built-in rules will override them.

pub fn get_rule(&self, id: &str) -> Option<&dyn Rule>

Get a rule by its ID.

Custom rules take precedence over built-in rules.

pub fn has_rule(&self, id: &str) -> bool

Check if a rule with the given ID exists.

pub fn rule_ids(&self) -> Vec<&str>

Get all rule IDs.

pub fn check_all(&self, ctx: &AnalysisContext<'_>) -> Vec<Diagnostic>

Run all rules on the given analysis context.

pub fn check_rules( &self, ctx: &AnalysisContext<'_>, rule_ids: &[&str], ) -> Vec<Diagnostic>

Run specific rules on the given analysis context.

Trait Implementations

impl Default for PluginRegistry

fn default() -> Self

Returns the “default value” for a type.