Skip to main content

Context

Struct Context 

Source
pub struct Context<'a> {
    pub root: &'a Path,
    pub index: &'a FileIndex,
    pub registry: Option<&'a RuleRegistry>,
    pub facts: Option<&'a FactValues>,
    pub vars: Option<&'a HashMap<String, String>>,
    pub git_tracked: Option<&'a HashSet<PathBuf>>,
    pub git_blame: Option<&'a BlameCache>,
}
Expand description

Execution context handed to each rule during evaluation.

  • registry — available for rules that need to build and evaluate nested rules at runtime (e.g. for_each_dir). Tests that don’t exercise nested evaluation can set this to None.
  • facts — resolved fact values, computed once per Engine::run.
  • vars — user-supplied string variables from the config’s vars: section.
  • git_tracked — set of repo paths reported by git ls-files, computed once per run when at least one rule has git_tracked_only: true. None outside a git repo or when no rule asked for it. Rules that opt in consult it via Context::is_git_tracked.
  • git_blame — per-file git blame cache, computed lazily when at least one rule reports wants_git_blame(). None when no rule asked for it. Rules consult it via crate::git::BlameCache::get; both “outside a git repo” and “blame failed for this file” surface as a None lookup, which the rule treats as “silent no-op.”

Fields§

§root: &'a Path§index: &'a FileIndex§registry: Option<&'a RuleRegistry>§facts: Option<&'a FactValues>§vars: Option<&'a HashMap<String, String>>§git_tracked: Option<&'a HashSet<PathBuf>>§git_blame: Option<&'a BlameCache>

Implementations§

Source§

impl Context<'_>

Source

pub fn is_git_tracked(&self, rel_path: &Path) -> bool

True if rel_path is in git’s index. Returns false when no tracked-set was computed (no git repo, or no rule asked for it). Rules that opt into git_tracked_only therefore silently skip every entry outside a git repo, which is the right behaviour for the canonical “don’t let X be committed” use case.

Source

pub fn dir_has_tracked_files(&self, rel_path: &Path) -> bool

True if the directory at rel_path contains at least one git-tracked file. Used by dir_* rules opting into git_tracked_only. Same None-means-untracked semantics as Context::is_git_tracked.

Trait Implementations§

Source§

impl<'a> Debug for Context<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Context<'a>

§

impl<'a> RefUnwindSafe for Context<'a>

§

impl<'a> Send for Context<'a>

§

impl<'a> Sync for Context<'a>

§

impl<'a> Unpin for Context<'a>

§

impl<'a> UnsafeUnpin for Context<'a>

§

impl<'a> UnwindSafe for Context<'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, 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