archunit

Struct CheckOptions

Source
#[non_exhaustive]
pub struct CheckOptions { /* private fields */ }
Expand description

Options that control how one terminal architecture check runs.

The default is deliberately defensive and quiet: empty selections fail, logging is disabled, an existing graph cache may be reused, and test-only source targets are excluded. Builders consume and return the bag so a configured value can be cloned and branched without mutation.

Implementations§

Source§

impl CheckOptions

Source

pub const fn new() -> Self

Creates the ordinary strict, quiet check configuration.

Source

pub const fn allows_empty_tests(&self) -> bool

Returns whether a selector that matches nothing may pass.

Source

pub const fn with_allow_empty_tests(self, allow: bool) -> Self

Controls whether a selector that matches nothing may pass.

Source

pub const fn logging(&self) -> Option<&LoggingOptions>

Returns this check’s logging configuration, or None when it is quiet.

Source

pub fn with_logging(self, logging: LoggingOptions) -> Self

Enables per-check logging with the supplied configuration.

Source

pub const fn clears_cache(&self) -> bool

Returns whether the shared extraction cache must be cleared before this check.

Source

pub const fn with_clear_cache(self, clear: bool) -> Self

Controls whether extraction starts from an empty graph cache.

Source

pub const fn includes_test_sources(&self) -> bool

Returns whether Cargo test, example, and benchmark targets participate in analysis.

Source

pub const fn with_test_sources(self, include: bool) -> Self

Controls whether Cargo test, example, and benchmark targets participate in analysis.

Trait Implementations§

Source§

impl Clone for CheckOptions

Source§

fn clone(&self) -> CheckOptions

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CheckOptions

Source§

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

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

impl Default for CheckOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CheckOptions

Source§

fn eq(&self, other: &CheckOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for CheckOptions

Source§

impl StructuralPartialEq for CheckOptions

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.