Enum Verdict 

pub enum Verdict {
    Counts,
    Placeholder,
    DoesNotNameSubject,
    NotExecutable,
}

What one fenced block is worth as evidence about one item.

The variants are ordered by how far the block is from counting, and the report turns the best verdict among an item’s blocks into the finding it raises — so an item with one real example and three diagrams is clean, and an item with three ignored blocks is told which of its problems to fix first.

Variants

Counts

Evidence: compiled by the toolchain, names the item, asserts something real.

Placeholder

Compiled and names the item, and asserts nothing, or nothing that could be false.

DoesNotNameSubject

Compiled, asserts something, and never mentions the item it documents.

NotExecutable

ignored, or a fenced box of prose: compiled by nobody.

Implementations

impl Verdict

pub fn of(example: &Example, subject: &str) -> Verdict

Judge one block as evidence about the item named subject.

subject is the item’s own name — Capability, classify, parse — because that is what a caller writes. A method’s example may name the method or the type it is on; both are the caller naming the thing being documented.

use majordomus_cli::quality::policy::Verdict;
use majordomus_cli::quality::source::Example;

let e = Example::parse("", &[
    "let id = CapabilityId::parse(\"a.b\").unwrap();".into(),
    "assert_eq!(id.namespace(), \"a\");".into(),
]);
assert_eq!(Verdict::of(&e, "CapabilityId"), Verdict::Counts);

pub fn best(examples: &[&Example], subject: &str) -> Option<Verdict>

The best verdict among an item’s blocks: what the report acts on.

An item with no block at all has no verdict, which the caller reports as the missing example it is.

use majordomus_cli::quality::policy::Verdict;
use majordomus_cli::quality::source::Example;

let diagram = Example::parse("text", &["a picture".into()]);
let real = Example::parse("", &["assert!(Thing::new().ready());".into()]);
assert_eq!(Verdict::best(&[&diagram, &real], "Thing"), Some(Verdict::Counts));
assert_eq!(Verdict::best(&[], "Thing"), None);

pub fn code(self) -> Option<ViolationCode>

The finding this verdict raises, or None when the example counts.

use majordomus_cli::quality::policy::Verdict;
use majordomus_cli::quality::ViolationCode;
assert_eq!(Verdict::Counts.code(), None);
assert_eq!(Verdict::Placeholder.code(), Some(ViolationCode::RustExamplePlaceholder));

Trait Implementations

impl Clone for Verdict

fn clone(&self) -> Verdict

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Verdict

impl Debug for Verdict

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Verdict

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Verdict

impl JsonSchema for Verdict

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 Verdict

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

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

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

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 Verdict