Skip to main content

RepoState

Struct RepoState 

Source
pub struct RepoState {
    pub root: PathBuf,
    pub git_event: GitEvent,
    pub base_ref: String,
    pub staged_files: Vec<PathBuf>,
}
Expand description

Snapshot of repo metadata passed to every check execution.

base_ref is the merge-base ref between HEAD and the upstream tracking branch — the “branch divergence point” diff-aware tools (pre-commit run --from-ref, fallow audit --base) want. The gate runtime exposes it to shell checks via the KLASP_BASE_REF env var; sources that talk to other check tools (named recipes in v0.2, subprocess plugins in v0.3) read it directly off this struct.

Falls back to HEAD~1 when no upstream is configured (a fresh checkout, a detached HEAD, or a branch that has never been pushed). The fallback is best-effort — diff-aware tools that don’t recognise the ref simply lint the whole tree, which is the same behaviour they’d have without klasp.

staged_files carries the absolute paths of files in the current group’s scope when running in monorepo mode (i.e. the subset of staged files that belong to the klasp.toml group that owns this invocation). An empty Vec means “no scoping; the check sees the whole repo” — this is the back-compat value used by the single-config fallback path and by callers that do not dispatch per-group. Per-source consumption of staged_files for fine-grained scoping is deferred to issue #34 (rayon / named recipes); the field is present now so that data is available to checks without a further struct-breaking change.

Fields§

§root: PathBuf§git_event: GitEvent§base_ref: String§staged_files: Vec<PathBuf>

Staged files scoped to this group’s klasp.toml. Empty = whole-repo (single-config fallback or unscoped callers).

Trait Implementations§

Source§

impl Clone for RepoState

Source§

fn clone(&self) -> RepoState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RepoState

Source§

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

Formats the value using the given formatter. 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, 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.