Skip to main content

RuleContext

Struct RuleContext 

Source
pub struct RuleContext<'a> {
    pub files: &'a [DiscoveredFile],
    pub known_paths: &'a HashSet<String>,
    pub parsed_docs: &'a HashMap<String, ParsedDocument>,
    pub git_infos: &'a [GitFileInfo],
    pub project_root: &'a Path,
    pub freshness: Option<&'a FreshnessResult>,
    pub integrity: Option<&'a IntegrityResult>,
    pub config_quality: Option<&'a ConfigQualityResult>,
    pub agent_setup: Option<&'a AgentSetupResult>,
    pub structure: Option<&'a StructureResult>,
}
Expand description

Snapshot of project data available to rules during evaluation.

Contains both raw scan data (files, parsed docs, git info) and analysis results (freshness, integrity, etc.) so that rules can operate at whichever level of abstraction they prefer.

Fields§

§files: &'a [DiscoveredFile]

All discovered files in the project.

§known_paths: &'a HashSet<String>

Set of all known relative paths (for link validation).

§parsed_docs: &'a HashMap<String, ParsedDocument>

Parsed markdown documents keyed by relative path.

§git_infos: &'a [GitFileInfo]

Git metadata per file.

§project_root: &'a Path

Project root path.

§freshness: Option<&'a FreshnessResult>

Freshness / staleness analysis results.

§integrity: Option<&'a IntegrityResult>

Reference integrity analysis results.

§config_quality: Option<&'a ConfigQualityResult>

Configuration quality analysis results.

§agent_setup: Option<&'a AgentSetupResult>

Agent setup infrastructure analysis results.

§structure: Option<&'a StructureResult>

Project structure quality analysis results.

Auto Trait Implementations§

§

impl<'a> Freeze for RuleContext<'a>

§

impl<'a> RefUnwindSafe for RuleContext<'a>

§

impl<'a> Send for RuleContext<'a>

§

impl<'a> Sync for RuleContext<'a>

§

impl<'a> Unpin for RuleContext<'a>

§

impl<'a> UnsafeUnpin for RuleContext<'a>

§

impl<'a> UnwindSafe for RuleContext<'a>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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