Skip to main content

AuditEngine

lingora_core::prelude

Struct AuditEngine

pub struct AuditEngine { /* private fields */ }

Expand description

The main engine that drives the Lingora audit process.

AuditEngine is responsible for:

Discovering Fluent (.ftl) and Rust (.rs) files from configured paths
Building a Workspace model
Running the analysis Pipeline (parsing → document collection → classification → auditing)
Returning a complete AuditResult containing issues and classified documents

Implementations§

impl AuditEngine

pub fn run(&self) -> Result<AuditResult, LingoraError>

Executes the full audit pipeline and returns the result.

Steps performed (via Pipeline):

Parse all Fluent and Rust files
Aggregate entries into FluentDocuments per locale
Classify documents as Canonical / Primary / Variant / Orphan
Compare canonical vs targets (missing keys, redundants, signatures, etc.)
Validate Rust macro usage against canonical identifiers

Returns Ok(AuditResult) on success, even if issues are found (use AuditResult::is_ok() to check cleanliness).

Trait Implementations§

impl Debug for AuditEngine

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

Formats the value using the given formatter. Read more

impl TryFrom<&LingoraToml> for AuditEngine

type Error = LingoraError

The type returned in the event of a conversion error.

fn try_from(settings: &LingoraToml) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for AuditEngine

impl RefUnwindSafe for AuditEngine

impl Send for AuditEngine

impl Sync for AuditEngine

impl Unpin for AuditEngine

impl UnsafeUnpin for AuditEngine

impl UnwindSafe for AuditEngine

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

type Proj<U: 'src> = U

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

impl<T, S> SpanWrap<S> for T
where S: WrappingSpan<T>,

fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned

Invokes WrappingSpan::make_wrapped to wrap an AST node in a span.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.