Skip to main content

DepCheck

Struct DepCheck 

Source
pub struct DepCheck { /* private fields */ }
Expand description

Configuration for a dependency check.

§Example

use dev_deps::{DepCheck, DepScope};
use dev_report::Severity;

let check = DepCheck::new("my-crate", "0.1.0")
    .scope(DepScope::All)
    .workspace()
    .allow("legacy-shim")
    .severity_threshold(Severity::Warning)
    .escalate_at_majors(3);

let _result = check.execute().unwrap();

Implementations§

Source§

impl DepCheck

Source

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Begin a new dependency check.

name and version are descriptive — they identify the subject in the produced Report.

Source

pub fn scope(self, scope: DepScope) -> Self

Pick which checks to run. Defaults to DepScope::All.

Source

pub fn dep_scope(&self) -> DepScope

Selected scope.

Source

pub fn in_dir(self, dir: impl Into<PathBuf>) -> Self

Run the subprocesses from dir instead of the current directory.

Source

pub fn workspace(self) -> Self

Pass --workspace so every workspace member is checked.

Source

pub fn exclude(self, pattern: impl Into<String>) -> Self

Exclude a crate from both scanners. May be called multiple times.

Source

pub fn allow(self, crate_name: impl Into<String>) -> Self

Suppress findings against a specific crate name. Matches both unused and outdated findings on crate_name.

Source

pub fn allow_all<I, S>(self, names: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Bulk version of allow.

Source

pub fn severity_threshold(self, threshold: Severity) -> Self

Discard findings whose severity is below threshold. Findings at or above the threshold are kept.

Source

pub fn escalate_at_majors(self, n: u32) -> Self

Escalate outdated findings to a failing check when the crate is at least n major versions behind. By default, outdated findings produce only Warn-verdict checks.

Source

pub fn subject(&self) -> &str

Subject name passed in via new.

Source

pub fn subject_version(&self) -> &str

Subject version passed in via new.

Source

pub fn execute(&self) -> Result<DepResult, DepError>

Execute the check.

Each enabled tool is invoked as a subprocess. Findings are filtered through the allow-list and severity threshold, then sorted by crate_name for determinism.

Trait Implementations§

Source§

impl Clone for DepCheck

Source§

fn clone(&self) -> DepCheck

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 DepCheck

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.