Struct CommandSummary 

pub struct CommandSummary {
    pub id: String,
    pub invocation: String,
    pub summary: String,
    pub origin: String,
    pub effect: String,
    pub group: Option<String>,
    pub projections: Projections,
}

One command, as an index shows it: enough to choose, never enough to have to skim.

Fields

id: String

The canonical identity.

invocation: String

The command line a person types.

summary: String

One line.

origin: String

Which program runs it.

effect: String

What running it changes.

group: Option<String>

The group it is found under.

projections: Projections

Where it appears.

Trait Implementations

impl Clone for CommandSummary

fn clone(&self) -> CommandSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CommandSummary

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 Serialize for CommandSummary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.