Struct CommandsConfig 

pub struct CommandsConfig {
    pub metadata: Metadata,
    pub commands: Vec<CommandDefinition>,
    pub global_options: Vec<OptionDefinition>,
    pub directives: Vec<DirectiveDefinition>,
}

Complete configuration for CLI/REPL commands

This is the root structure deserialized from YAML/JSON files. It contains metadata about the interface and all command definitions.

Example YAML

metadata:
  version: "1.0.0"
  prompt: "myapp"
  prompt_suffix: " > "
commands:
  - name: hello
    description: "Say hello"
    # ... more fields
global_options: []
directives:
  - implementation: repl_help
    name: aide
    description: "Afficher l'aide"

Fields

metadata: Metadata

Metadata about the application interface

commands: Vec<CommandDefinition>

List of all available commands

global_options: Vec<OptionDefinition>

Global options available to all commands

directives: Vec<DirectiveDefinition>

Overrides of the REPL directives (:help, :quit…)

Each entry replaces the name, aliases and description of the directive selected by its implementation; directives without an entry keep their defaults. Empty when the section is absent. See crate::config::directive.

Trait Implementations

impl Clone for CommandsConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandsConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandsConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandsConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommandsConfig

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 CommandsConfig