Struct Feature 

pub struct Feature {

    pub id: String,
    pub title: String,
    pub short_title: Option<String>,
    pub headline: String,
    pub summary: String,
    pub status: String,
    pub weight: u32,
    pub featured: bool,
    pub domain: Option<String>,
    pub areas: Vec<String>,
    pub audiences: Vec<String>,
    pub modules: Vec<String>,
    pub commands: Vec<String>,
    pub kinds: Vec<String>,
    pub rules: Vec<String>,
    pub docs: Vec<String>,
    pub adrs: Vec<String>,
    pub claims: Vec<String>,
    pub use_cases: Vec<String>,
    pub cockpit: Vec<String>,
    pub web: Vec<String>,
    pub related: Vec<String>,
    pub tags: Vec<String>,
    pub route: String,
    pub source: String,
    pub body: String,
}

One product feature, as its file declares it plus the facts the file cannot hold: where it came from and where it is published.

Fields

id: String

The identity, the slug and the file name.

title: String

The feature as a heading.

short_title: Option<String>

Two or three words for a card or a matrix row.

headline: String

The promise a visitor reads first.

summary: String

One line: what it does.

status: String

stable, draft or deprecated.

weight: u32

Presentation order, lowest first.

featured: bool

Whether the homepage shows it as a chapter.

domain: Option<String>

The product domain it belongs to, by id: exactly one. Editorial; the domain’s members are derived from this field and listed nowhere else.

areas: Vec<String>

The operational areas of the why catalogue it serves.

audiences: Vec<String>

The audiences of the why catalogue it is written for.

modules: Vec<String>

Capability modules of the executable it is made of.

commands: Vec<String>

Public commands of the shell tool it is made of.

kinds: Vec<String>

Object kinds of the layer it is made of.

rules: Vec<String>

Rules of the effective set that govern it, by id without the version.

docs: Vec<String>

The documents that explain it, by repository-relative path.

adrs: Vec<String>

The decisions behind it, by declared id.

claims: Vec<String>

Claims that say what is guaranteed here.

use_cases: Vec<String>

Use cases that show it in use.

cockpit: Vec<String>

Areas of the Cockpit that show it.

web: Vec<String>

Web surfaces of the topology it is offered through.

related: Vec<String>

Features explicitly related to this one. The reverse is derived.

tags: Vec<String>

Free tags.

route: String

Derived: /features/<id>/. Never authored; the schema refuses a route key.

source: String

Derived: the repository-relative file the record came from.

body: String

The Markdown body, without its front matter.

Implementations

impl Feature

pub fn label(&self) -> &str

The name a narrow column shows.

Trait Implementations

impl Clone for Feature

fn clone(&self) -> Feature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Feature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Feature

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Feature

impl JsonSchema for Feature

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 Ordered for Feature

fn order_key(&self) -> OrderKey<'_>

The four parts this item is ordered by. Borrowed from the item: building a key allocates nothing, so sorting a large collection costs the comparisons and no more.

impl PartialEq for Feature

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

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 Feature