Struct GateCtx 

pub struct GateCtx {
    pub repo_root: Utf8PathBuf,
    /* private fields */
}

Where a gate runs: the repository root pre-commit invoked it from, and the subject filter that bounds what it judges there.

Subject paths and support paths

A subject path is one whose content the gate judges and which can appear in a finding. A support path is one the gate reads to know what to judge: the canon manifest, the known-issue records, the docs-root resolution, the tracking registry. The filter governs subject paths. Self::path and read_text stay open, because a filter that reached support paths would let a project disable a gate by excluding the file that configures it.

Every route a subject path takes

There are three, and each passes through Self::subjects, so a gate author cannot reach an unfiltered subject list:

1. The &[String] a gate is handed, filtered in commands::gate.
2. walk_files, which filters before it returns.
3. crate::gates::spec_change_is_typed, which resolves its own candidate set and filters it explicitly.

canon::every_subject_producer_is_filter_aware holds that list.

Fields

repo_root: Utf8PathBuf

The repository root; every path a gate reads or reports is relative to it.

Implementations

impl GateCtx

pub fn new(repo_root: impl Into<Utf8PathBuf>) -> Self

A context rooted at the given repository, judging everything.

This is the shape every test and every internal caller wants. The command path uses Self::with_filter.

pub fn with_filter( repo_root: impl Into<Utf8PathBuf>, filter: PathFilter, ) -> Self

A context whose gate judges only what the filter admits.

pub fn path(&self, relative: impl AsRef<Utf8Path>) -> Utf8PathBuf

Resolve a repository-relative path for reading.

Deliberately unfiltered: a gate reads its support files through here.

pub fn subjects<P: AsRef<Utf8Path>>( &self, candidates: impl IntoIterator<Item = P>, ) -> Vec<P>

The subset of candidates this gate judges.

Every subject path pre-commit or an operator hands a gate comes through here, and the registry whitelist binds.

pub fn retained<P: AsRef<Utf8Path>>( &self, candidates: impl IntoIterator<Item = P>, ) -> Vec<P>

The subset of candidates this gate’s exclusions leave.

For a subject set the gate discovered itself. See PathFilter::retains.

pub const fn filter(&self) -> &PathFilter

The filter itself, for --explain and for the renderer.

Trait Implementations

impl Debug for GateCtx

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

Formats the value using the given formatter.