Struct ValidatorRef 

pub struct ValidatorRef {
    pub name: String,
    pub function: String,
    pub defined_in: Option<String>,
    pub present: bool,
}

The validator a dispatched rule names, and whether anything defines it.

A validator is not a path. validator: adr names the shell function mj_validate_adr, which the doctrine dispatcher calls; the tool finds it by scanning lib/, exactly as majordomus doctor does. Reading it as a path is a mistake worth recording here, because it is the one this type was introduced to fix: it makes every dispatched rule in the vendored package report as naming something that is not in the tree, which is the opposite of true — those are the best-enforced rules there are.

Example

use majordomus_cli::rules::ValidatorRef;
let v = ValidatorRef {
    name: "adr".into(),
    function: "mj_validate_adr".into(),
    defined_in: Some("lib/adr.sh".into()),
    present: true,
};
assert_eq!(v.function, "mj_validate_adr");

Fields

name: String

The name the rule declares, without the mj_validate_ prefix.

function: String

The function the dispatcher calls.

defined_in: Option<String>

The file that defines it, when one does.

present: bool

Whether anything in lib/ defines it.

Trait Implementations

impl Clone for ValidatorRef

fn clone(&self) -> ValidatorRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatorRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValidatorRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ValidatorRef

impl JsonSchema for ValidatorRef

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 ValidatorRef

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

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 ValidatorRef