LintEngine

Struct LintEngine 

Source
pub struct LintEngine { /* private fields */ }
Expand description

Markdown linting engine

Implementations§

Source§

impl LintEngine

Source

pub fn new() -> Self

Create a new lint engine with no rules

Source

pub fn with_registry(registry: RuleRegistry) -> Self

Create a lint engine with an existing rule registry

Source

pub fn registry(&self) -> &RuleRegistry

Get the underlying rule registry

Source

pub fn registry_mut(&mut self) -> &mut RuleRegistry

Get a mutable reference to the rule registry

Source

pub fn lint_document(&self, document: &Document) -> Result<Vec<Violation>>

Lint a document with all registered rules

Source

pub fn lint_document_with_config( &self, document: &Document, config: &Config, ) -> Result<Vec<Violation>>

Lint a document with specific configuration

Source

pub fn lint_content(&self, content: &str, path: &str) -> Result<Vec<Violation>>

Lint content string directly (convenience method)

Source

pub fn available_rules(&self) -> Vec<&'static str>

Get all available rule IDs

Source

pub fn enabled_rules(&self, config: &Config) -> Vec<&dyn Rule>

Get enabled rules based on configuration

Trait Implementations§

Source§

impl Default for LintEngine

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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, 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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.