Struct Enforcement 

pub struct Enforcement {
    pub mode: Mode,
    pub validator: Option<String>,
    pub category: Option<String>,
    pub exit_code: Option<i64>,
    pub enforced_by: Option<String>,
    pub tests: Vec<String>,
    pub reviewed_because: Option<String>,
}

The enforcement block of a rule, read from x-majordomus.

Example

Read from front matter rather than built by hand; this is the shape a gated rule produces, and the mode is decided by what the block actually names.

use majordomus_cli::rules::{Enforcement, Mode};
let e = Enforcement {
    mode: Mode::Gated,
    validator: None,
    category: None,
    exit_code: None,
    enforced_by: None,
    tests: vec!["test/cases/07_scope.sh".into()],
    reviewed_because: None,
};
assert_eq!(e.mode, Mode::Gated);

Fields

mode: Mode

Which of the two canonical modes, or neither.

validator: Option<String>

The validator the dispatcher calls, when the mode is dispatched.

category: Option<String>

The diagnostic category the validator reports under.

exit_code: Option<i64>

The exit code the validator uses to refuse.

enforced_by: Option<String>

Which boundary enforces it: the word the rule’s own block uses.

tests: Vec<String>

Every test the block names, in the order it names them.

reviewed_because: Option<String>

Why nothing executable can express this rule, when the mode is reviewed. Required there: a declared exemption with no reason is the debt it exists to replace.

Trait Implementations

impl Clone for Enforcement

fn clone(&self) -> Enforcement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Enforcement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Enforcement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Enforcement

impl JsonSchema for Enforcement

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 PartialEq for Enforcement

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

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 Enforcement