Enum ViolationKind

#[non_exhaustive]
pub enum ViolationKind {
    EmptyTest,
    Cycle,
    FilePattern,
    FileDependency,
    ExternalModuleDependency,
    CustomFile,
    LayerDependency,
    SliceDependency,
    MetricZone,
    CustomMetric,
    MetricThreshold,
    MetricPredicate,
}

The machine-readable family of a Violation.

Spellings are shared across ArchUnit ports and are stable report keys.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

EmptyTest

A selector matched no subject, so the rule judged nothing.

Cycle

The selected projected graph contains a circular dependency path.

FilePattern

A selected file disagrees with a filename, folder, or path pattern.

FileDependency

An internal file dependency disagrees with an allowlist or denylist rule.

ExternalModuleDependency

An external crate dependency disagrees with an allowlist or denylist rule.

CustomFile

A selected file disagrees with a user-defined predicate.

LayerDependency

An internal dependency disagrees with a named-layer policy.

SliceDependency

A projected dependency disagrees with a slice policy.

MetricZone

A file component lies in a discouraged abstractness/instability zone.

CustomMetric

A user-defined metric value did not satisfy its predicate.

MetricThreshold

A metric value did not meet an exact numeric threshold.

MetricPredicate

A built-in metric value did not satisfy a user predicate.

Implementations

impl ViolationKind

pub const fn as_str(self) -> &'static str

Returns the stable lowercase, hyphen-separated report key.

Trait Implementations

impl Clone for ViolationKind

fn clone(&self) -> ViolationKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViolationKind

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

Formats the value using the given formatter.

impl Display for ViolationKind

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

Formats the value using the given formatter.

impl Hash for ViolationKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ViolationKind

fn cmp(&self, other: &ViolationKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ViolationKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ViolationKind

fn partial_cmp(&self, other: &ViolationKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ViolationKind

impl Eq for ViolationKind

impl StructuralPartialEq for ViolationKind