Enum Violation

#[non_exhaustive]
pub enum Violation {
    EmptyTest(EmptyTestViolation),
    Cycle(CycleViolation),
    FilePattern(FilePatternViolation),
    FileDependency(FileDependencyViolation),
    ExternalModuleDependency(ExternalModuleDependencyViolation),
    CustomFile(CustomFileViolation),
    LayerDependency(LayerDependencyViolation),
    SliceDependency(SliceDependencyViolation),
    MetricZone(MetricZoneViolation),
    CustomMetric(CustomMetricViolation),
    MetricThreshold(MetricThresholdViolation),
    MetricPredicate(MetricPredicateViolation),
}

One data-carrying disagreement between a project and an architecture rule.

A complete rule result is Vec<Violation>: an empty vector means the rule passed. This enum deliberately contains no user-facing prose; the testing layer formats each variant later.

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(EmptyTestViolation)

The rule selected no subject and therefore could not judge its predicate.

Cycle(CycleViolation)

A circular path exists in the selected projected graph.

FilePattern(FilePatternViolation)

A file disagrees with a name or location predicate.

FileDependency(FileDependencyViolation)

An internal dependency disagrees with a relational file rule.

ExternalModuleDependency(ExternalModuleDependencyViolation)

An external crate dependency disagrees with a relational file rule.

CustomFile(CustomFileViolation)

A file disagrees with a user-defined predicate.

LayerDependency(LayerDependencyViolation)

An internal dependency disagrees with a named-layer policy.

SliceDependency(SliceDependencyViolation)

A projected dependency disagrees with a slice policy.

MetricZone(MetricZoneViolation)

A file component lies inside a discouraged metrics zone.

CustomMetric(CustomMetricViolation)

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

MetricThreshold(MetricThresholdViolation)

A metric value did not meet an exact numeric threshold.

MetricPredicate(MetricPredicateViolation)

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

Implementations

impl Violation

pub const fn kind(&self) -> ViolationKind

Returns this violation’s stable family.

pub const fn as_empty_test(&self) -> Option<&EmptyTestViolation>

Returns the empty-test data when this is an empty-test violation.

pub const fn as_cycle(&self) -> Option<&CycleViolation>

Returns the cycle data when this is a cycle violation.

pub const fn as_file_pattern(&self) -> Option<&FilePatternViolation>

Returns the file-pattern data when this is a file-pattern violation.

pub const fn as_file_dependency(&self) -> Option<&FileDependencyViolation>

Returns the file-dependency data when this is a file-dependency violation.

pub const fn as_external_module_dependency( &self, ) -> Option<&ExternalModuleDependencyViolation>

Returns the external-module data when this is an external-module dependency violation.

pub const fn as_custom_file(&self) -> Option<&CustomFileViolation>

Returns the custom-file data when this is a custom predicate violation.

pub const fn as_layer_dependency(&self) -> Option<&LayerDependencyViolation>

Returns the named-layer dependency data when this is a layer violation.

pub const fn as_slice_dependency(&self) -> Option<&SliceDependencyViolation>

Returns the projected slice dependency data when this is a slice violation.

pub const fn as_metric_zone(&self) -> Option<&MetricZoneViolation>

Returns metric-zone data when this is a distance-zone violation.

pub const fn as_custom_metric(&self) -> Option<&CustomMetricViolation>

Returns custom-metric data when a user predicate rejected a type value.

pub const fn as_metric_threshold(&self) -> Option<&MetricThresholdViolation>

Returns numeric threshold data when a metric value missed its boundary.

pub const fn as_metric_predicate(&self) -> Option<&MetricPredicateViolation>

Returns built-in metric predicate data when a callback rejected a value.

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl From<CustomFileViolation> for Violation

fn from(violation: CustomFileViolation) -> Self

Converts to this type from the input type.

impl From<CustomMetricViolation> for Violation

fn from(violation: CustomMetricViolation) -> Self

Converts to this type from the input type.

impl From<CycleViolation> for Violation

fn from(violation: CycleViolation) -> Self

Converts to this type from the input type.

impl From<EmptyTestViolation> for Violation

fn from(violation: EmptyTestViolation) -> Self

Converts to this type from the input type.

impl From<ExternalModuleDependencyViolation> for Violation

fn from(violation: ExternalModuleDependencyViolation) -> Self

Converts to this type from the input type.

impl From<FileDependencyViolation> for Violation

fn from(violation: FileDependencyViolation) -> Self

Converts to this type from the input type.

impl From<FilePatternViolation> for Violation

fn from(violation: FilePatternViolation) -> Self

Converts to this type from the input type.

impl From<LayerDependencyViolation> for Violation

fn from(violation: LayerDependencyViolation) -> Self

Converts to this type from the input type.

impl From<MetricPredicateViolation> for Violation

fn from(violation: MetricPredicateViolation) -> Self

Converts to this type from the input type.

impl From<MetricThresholdViolation> for Violation

fn from(violation: MetricThresholdViolation) -> Self

Converts to this type from the input type.

impl From<MetricZoneViolation> for Violation

fn from(violation: MetricZoneViolation) -> Self

Converts to this type from the input type.

impl From<SliceDependencyViolation> for Violation

fn from(violation: SliceDependencyViolation) -> Self

Converts to this type from the input type.