Enum ArtifactKind 

pub enum ArtifactKind {
    Case,
    Gate,
    Unknown,
}

What a path a rule names actually is, decided by what drives it rather than by where it sits.

The corpus names two kinds and this distinction is the difference between a verdict and a mechanism. A case is driven by a runner, so an execution of it can be recorded and the repository can show that it passed. A gate is an executable check a CI gate runs as its own command, or a unit-test module (src/<module>/tests.rs) the gate running the crate’s cargo test compiles: it refuses violations on every run, and this repository records no verdict for it, so what can be shown is the mechanism and not the result. Anything else a rule names is proof only in prose.

Example

use majordomus_cli::rules::ArtifactKind;
assert_eq!(ArtifactKind::Case.label(), "case");
assert_eq!(ArtifactKind::Gate.label(), "gate");

Variants

Case

A behavioural case a runner drives; executions of it are recorded.

Gate

An executable check a CI gate runs as its own command, or a unit-test module the gate running the crate’s cargo test compiles.

Unknown

Neither. Nothing can run it, so nothing can ever record it.

Implementations

impl ArtifactKind

pub fn label(self) -> &'static str

The word every surface prints for what drives this artifact, so that a gate and a case are never rendered as the same kind of thing.

use majordomus_cli::rules::ArtifactKind;
assert_eq!(ArtifactKind::Unknown.label(), "unknown");

Trait Implementations

impl Clone for ArtifactKind

fn clone(&self) -> ArtifactKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ArtifactKind

impl Debug for ArtifactKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArtifactKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ArtifactKind

impl JsonSchema for ArtifactKind

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for ArtifactKind

fn cmp(&self, other: &ArtifactKind) -> 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 ArtifactKind

fn eq(&self, other: &ArtifactKind) -> 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 ArtifactKind

fn partial_cmp(&self, other: &ArtifactKind) -> 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 Serialize for ArtifactKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ArtifactKind