Struct Moment 

pub struct Moment {

    pub id: String,
    pub title: String,
    pub short_title: Option<String>,
    pub hook: String,
    pub summary: String,
    pub status: String,
    pub severity: String,
    pub frequency: String,
    pub weight: u32,
    pub featured: bool,
    pub audiences: Vec<String>,
    pub areas: Vec<String>,
    pub lifecycle: Vec<String>,
    pub tags: Vec<String>,
    pub signals: Vec<Signal>,
    pub examples: Vec<Example>,
    pub commands: Vec<String>,
    pub capabilities: Vec<String>,
    pub claims: Vec<String>,
    pub doctrines: Vec<String>,
    pub use_cases: Vec<String>,
    pub related: Vec<String>,
    pub aliases: Vec<String>,
    pub route: String,
    pub source: String,
    pub body: String,
    /* private fields */
}

One operational moment, as its file declares it plus the two 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 moment as a heading.

short_title: Option<String>

Two or three words for a narrow column, when the record carries one.

hook: String

The first-person line an index shows.

summary: String

One line: what is actually wrong.

status: String

stable, draft or deprecated.

severity: String

low, medium or high.

frequency: String

rare, occasional, common or constant.

weight: u32

Presentation order, lowest first.

featured: bool

Whether the homepage shows it.

audiences: Vec<String>

The audiences that recognise it.

areas: Vec<String>

The operational areas it falls under.

lifecycle: Vec<String>

The stages of work at which it shows up.

tags: Vec<String>

Free tags.

signals: Vec<Signal>

The observable symptoms.

examples: Vec<Example>

The concrete situations.

commands: Vec<String>

Commands of the tool that answer it.

capabilities: Vec<String>

Capability ids of the executable that answer it.

claims: Vec<String>

Claims that say what is guaranteed here.

doctrines: Vec<String>

Rules of the effective set that govern it.

use_cases: Vec<String>

Use cases that show the way out.

related: Vec<String>

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

aliases: Vec<String>

Other words a reader might search for.

route: String

Derived: /why/<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 Moment

pub fn search_text(&self) -> String

The text a search reads: everything a reader might remember about this moment.

pub fn matches(&self, needle: &str) -> bool

Does the lower-cased needle occur anywhere in the search text? The text was built once, when the catalogue was; this is a substring test and nothing else.

pub fn label(&self) -> &str

The name a narrow column shows.

Trait Implementations

impl Clone for Moment

fn clone(&self) -> Moment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Moment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Moment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Moment

impl JsonSchema for Moment

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 Moment

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 Moment

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

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 Moment