Enum Class 

pub enum Class {
    Blocking,
    Advisory,
    Unknown,
}

What a rule declares about how strongly it binds.

The repository has exactly two, and they are not severities on a scale: blocking means a gate refuses the work, advisory means a reader is expected to have read it. A rule whose front matter says neither is reported as Class::Unknown rather than defaulted, because guessing here is how a blocking rule quietly becomes advice.

Example

use majordomus_cli::rules::Class;
assert_eq!(Class::Blocking.label(), "blocking");
assert_eq!(Class::parse("advisory"), Class::Advisory);

Variants

Blocking

A gate refuses work that violates it.

Advisory

Normative for whoever reads it; nothing refuses a violation.

Unknown

The front matter declared no class, or one this repository does not know.

Implementations

impl Class

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

The word every surface prints for this class, written here once so the command line, the API and the Cockpit cannot disagree about what to call it.

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

pub fn parse(word: &str) -> Class

Read a class from the front matter, without defaulting.

use majordomus_cli::rules::Class;
assert_eq!(Class::parse(" blocking "), Class::Blocking);
assert_eq!(Class::parse(""), Class::Unknown);

Trait Implementations

impl Clone for Class

fn clone(&self) -> Class

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Class

impl Debug for Class

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Class

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Class

impl JsonSchema for Class

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 Class

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

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

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

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 Class