Struct Explained 

pub struct Explained {
    pub code: String,
    pub name: String,
    pub class: Class,
    pub exit_code: u8,
    pub title: String,
    pub help: String,
    pub retired: bool,
    pub page: Option<String>,
}

One code explained.

Fields

code: String

The code (SH2003).

name: String

Its kebab-case name (missing-file), as stable as the code.

class: Class

Its class, which sets the exit code.

exit_code: u8

The exit code of an error with it.

title: String

What went wrong, in a few words.

help: String

How to fix it, in a line.

retired: bool

Whether it is retired: no error gives it any more.

page: Option<String>

Its page, in Markdown, when one code was asked for.

Trait Implementations

impl Clone for Explained

fn clone(&self) -> Explained

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Explained

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Explained

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Explained

impl JsonSchema for Explained

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 Explained

fn eq(&self, other: &Explained) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Explained

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 Explained