Skip to main content

RuleRegistry

Struct RuleRegistry 

Source
pub struct RuleRegistry {
    pub rule_schemas: BTreeMap<String, Map<String, Value>>,
    pub rule_aliases: BTreeMap<String, HashMap<String, String>>,
}
Expand description

Registry of all known rules and their config schemas

Fields§

§rule_schemas: BTreeMap<String, Map<String, Value>>

Map of rule name (e.g. “MD013”) to set of valid config keys and their TOML value types

§rule_aliases: BTreeMap<String, HashMap<String, String>>

Map of rule name to config key aliases

Implementations§

Source§

impl RuleRegistry

Source

pub fn from_rules(rules: &[Box<dyn Rule>]) -> Self

Build a registry from a list of rules

Source

pub fn rule_names(&self) -> BTreeSet<String>

Get all known rule names

Source

pub fn config_keys_for(&self, rule: &str) -> Option<BTreeSet<String>>

Get the valid configuration keys for a rule, including both original and normalized variants

Source

pub fn canonical_config_key(&self, rule: &str, key: &str) -> Option<&str>

Resolve a key as the user wrote it to the schema key it names, trying the rule’s aliases and the separator/case variants.

Returns None when the rule does not accept the key at all. A key that resolves may still carry a sentinel value, so this answers “is this key known?” where RuleRegistry::expected_value_for answers “what type must it be?”.

Source

pub fn expected_value_for(&self, rule: &str, key: &str) -> Option<&Value>

Get the expected value type for a rule’s configuration key, trying variants. Returns None both for an unknown key and for sentinel values (nullable Option fields, polymorphic fields that accept multiple TOML types), which signals the caller to skip type checking while still recognizing the key as valid. Use RuleRegistry::canonical_config_key to tell those two cases apart.

Source

pub fn resolve_rule_name(&self, name: &str) -> Option<String>

Resolve any rule name (canonical or alias) to its canonical form Returns None if the rule name is not recognized

Resolution order:

  1. Direct canonical name match
  2. Static aliases (built-in markdownlint aliases)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more