Skip to main content

CheckArgs

Struct CheckArgs 

Source
pub struct CheckArgs {
    pub paths: Vec<PathBuf>,
    pub staged: bool,
    pub diff: Option<String>,
    pub tip: Option<String>,
    pub pre_commit_push: bool,
    pub format: OutputFormat,
    pub fail_on: Option<Severity>,
    pub cache_only: bool,
    pub push_gate: bool,
}

Fields§

§paths: Vec<PathBuf>

Files or directories to check. Duplicates and overlaps are collapsed, so drep check a.rs . analyzes a.rs once.

§staged: bool

Check the files staged for commit. For a pre-commit hook.

§diff: Option<String>

Check the files changed since REF, e.g. origin/main. For pre-push.

§tip: Option<String>

The commit to diff to. Defaults to HEAD. Only valid with --diff.

A pre-push hook needs this: git can push a ref that is not the checked-out one (git push origin feature:feature from another branch, or git push --all), and diffing to HEAD there reviews a different branch and lets the pushed code through unseen.

§pre_commit_push: bool

Read the pushed base and tip from pre-commit’s hook environment.

Used by the published drep-check-push hook. pre-commit otherwise passes filenames, which would make drep review whole files instead of the hunks between PRE_COMMIT_FROM_REF and PRE_COMMIT_TO_REF.

§format: OutputFormat§fail_on: Option<Severity>

Also block on LLM findings at or above this severity.

Deterministic tool findings always block; this opts the LLM’s findings into gating too. Left unset, they inform without blocking - which is the useful default, because the model emits style suggestions on nearly every file.

§cache_only: bool

Use cached LLM reviews only; never contact a provider.

An uncached file exits 3 without warming it; run a normal check to populate the missing entry. The generated pre-push hook uses --push-gate for the full warm-and-reconnect handshake.

§push_gate: bool

Prepare a push without resuming a stale remote connection.

Cached reviews pass immediately. A cold review is completed and cached, then exits 3 so Git reconnects; repeating git push uses the cache.

Trait Implementations§

Source§

impl Args for CheckArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Debug for CheckArgs

Source§

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

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

impl FromArgMatches for CheckArgs

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

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> 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> 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: Sized + 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: Sized + 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, 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