Skip to main content

Engine

Struct Engine 

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

A configured engine instance.

Implementations§

Source§

impl Engine

Source

pub fn new(config: Config, rule_sets: Vec<Box<dyn RuleSet>>) -> Self

Create a new engine with the given configuration and rule sets.

Source

pub fn with_clock( config: Config, rule_sets: Vec<Box<dyn RuleSet>>, clock: Box<dyn Clock>, ) -> Self

Create an engine with a custom clock (for deterministic tests).

Source

pub fn lint(&self, source: &[u8]) -> LintResult

Lint a UTF-8 text buffer. Returns diagnostics without modifying input.

Source

pub fn fix(&self, source: &[u8], mode: FixMode) -> FixResult

Lint and apply fixes. Returns fixed source and audit log.

Fix application order follows FR-016: (span.end DESC, span.start DESC, rule_id ASC, replacement ASC) so reverse-byte application preserves earlier-span offsets and equal-span ties break deterministically.

Uses the confidence threshold configured in the engine’s Config. To supply a per-call override (e.g., from a --confidence CLI flag or an HTTP request field), use Engine::fix_with_threshold.

Source

pub fn fix_with_threshold( &self, source: &[u8], mode: FixMode, threshold_override: Option<f32>, ) -> Result<FixResult, InvalidThreshold>

Lint and apply fixes using an optional per-call confidence threshold.

When threshold_override is Some, it replaces the config-level threshold for this call only and is validated against [0.0, 1.0]. When None, the engine falls back to Config::confidence_threshold.

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, 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.
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