Enum Category 

pub enum Category {
    Interface,
    Documentation,
    Api,
    Protocol,
    Report,
}

What a surface is for, which is how a reader is shown it.

A category is the one piece of intent that a mount cannot carry: /openapi.json and /swagger sit beside each other and are a document and a viewer for it. Grouping is derived from this field and never from a list of paths kept somewhere else.

Variants

Interface

Something a person opens and looks at: the home page, the Cockpit.

Documentation

Prose and reference written for a person: the site, the Swagger UI.

Api

A machine-readable surface of the capability registry.

Protocol

A wire protocol another program speaks.

Report

Generated evidence of a run: a test report, a benchmark report.

Implementations

impl Category

pub const ALL: [Category; 5]

Every category, in the order a listing shows them.

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

The heading a person reads.

use majordomus_cli::web::model::Category;
assert_eq!(Category::Api.title(), "API");

Trait Implementations

impl Clone for Category

fn clone(&self) -> Category

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Category

impl Debug for Category

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Category

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Category

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

Formats the value using the given formatter.

impl Eq for Category

impl JsonSchema for Category

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 Category

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

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

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

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 Category