Enum ExampleRequirement 

pub enum ExampleRequirement {
    Required,
    NotApplicable {
        reason: &'static str,
    },
}

Whether an item owes an executable example, and when it does not, why not.

Variants

Required

It owes one.

NotApplicable

It does not, for this reason. The reason is printed in the report, so that what the policy does not ask for is as visible as what it does.

Fields

reason: &'static str

Why not, in the report’s own words.

Implementations

impl ExampleRequirement

pub fn of(item: &Item) -> Self

Classify an item. Derived from the item’s kind and shape; nothing declares this.

use majordomus_cli::quality::policy::ExampleRequirement;
use majordomus_cli::quality::source::Inventory;

let dir = tempfile::tempdir().unwrap();
let src = dir.path().join("src");
std::fs::create_dir_all(&src).unwrap();
std::fs::write(src.join("lib.rs"), r#"//! Root.
/// A limit that matters.
pub const LIMIT: usize = 10;
/// Counts.
pub fn count() -> usize { LIMIT }
"#).unwrap();
let inv = Inventory::of_crate(dir.path()).unwrap();

let f = ExampleRequirement::of(inv.item("majordomus_cli::count").unwrap());
assert_eq!(f, ExampleRequirement::Required);

let c = ExampleRequirement::of(inv.item("majordomus_cli::LIMIT").unwrap());
assert!(matches!(c, ExampleRequirement::NotApplicable { .. }));

pub fn is_required(&self) -> bool

Does this item owe an example?

use majordomus_cli::quality::policy::ExampleRequirement;
assert!(ExampleRequirement::Required.is_required());
assert!(!ExampleRequirement::NotApplicable { reason: "x" }.is_required());

pub fn reason(&self) -> Option<&'static str>

The reason it does not, or None when it does.

Trait Implementations

impl Clone for ExampleRequirement

fn clone(&self) -> ExampleRequirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleRequirement

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

Formats the value using the given formatter.

impl Deserialize<'static> for ExampleRequirement

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

where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExampleRequirement

impl JsonSchema for ExampleRequirement

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 ExampleRequirement

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

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 ExampleRequirement