Struct CommandSuggestion 

pub struct CommandSuggestion {
    pub description: String,
    pub command: String,
}

A structured object representing a suggestion for a shell command and its explanation

Fields

description: String

A clear, concise, human-readable explanation of the generated command, usually a single sentence. This description is for the end-user to help them understand the command before executing it.

command: String

The command template string. Use {{variable-name}} syntax for any placeholders that require user input. For ephemeral values like commit messages or sensitive values like API keys or passwords, use the triple-brace syntax {{{variable-name}}}.

Trait Implementations

impl Debug for CommandSuggestion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandSuggestion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CommandSuggestion

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.