Skip to main content

LintOptions

Struct LintOptions 

Source
#[non_exhaustive]
pub struct LintOptions { pub deadline: Option<Instant>, }
Expand description

Per-call options for Engine::lint_with_options.

Phase 1 status (current build): the type surface ships, but Engine::lint_with_options IGNORES deadline. The pass always runs to completion, returns truncated: false, and leaves candidates_processed / candidates_total at 0. The semantics below describe the Phase 2 behavior that lands in tasks T007–T009; consult the changelog (Appendix C in the security whitepaper) before relying on deadline behavior in production.

deadline is an absolute wall-clock instant after which the engine MUST abort cooperatively. Spec §R1, §R3:

  • None (default) — no budget; lint runs to completion.
  • Some(d) where d <= Instant::now() — pre-pass abort returns immediately with LintResult { truncated: true, candidates_processed: 0, candidates_total: 0, diagnostics: vec![] }.
  • Some(d) where d > Instant::now() — engine checks the deadline at each candidate boundary; on expiry the loop breaks and LintResult.truncated is set to true with partial counts.

The choice of Instant over Duration is deliberate: callers stamp the deadline once at the boundary they care about (request arrival, document permit acquisition for batch) and the engine carries no implicit clock. This makes the budget composable across BatchEngine permit waits and HTTP middleware.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§deadline: Option<Instant>

Absolute wall-clock deadline after which the lint pass MUST abort cooperatively. See struct-level docs for semantics — and the Phase 1 status note: the current build ignores this field, deadline-driven cancellation lands in Phase 2.

Trait Implementations§

Source§

impl Clone for LintOptions

Source§

fn clone(&self) -> LintOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LintOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LintOptions

Source§

fn default() -> LintOptions

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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