Struct DirectiveDefinition 

pub struct DirectiveDefinition {
    pub implementation: ReplDirective,
    pub name: String,
    pub aliases: Vec<String>,
    pub description: String,
}

Name, aliases and description of a REPL directive

Used both for the entries of the directives: configuration section and for the complete table returned by effective_directives.

Example YAML

implementation: repl_quit
name: quitter
aliases: [q]
description: "Enregistrer l'historique et quitter"

Fields

implementation: ReplDirective

Directive being defined or overridden

name: String

Name typed after : to invoke the directive

aliases: Vec<String>

Alternative names, also typed after :

description: String

Human-readable description for help text

Implementations

impl DirectiveDefinition

pub fn default_for(directive: ReplDirective) -> Self

Definition of directive with its default name, aliases and description

Example

use dynamic_cli::config::{DirectiveDefinition, ReplDirective};

let quit = DirectiveDefinition::default_for(ReplDirective::Quit);
assert_eq!(quit.name, "quit");
assert_eq!(quit.aliases, vec!["q".to_string()]);

Trait Implementations

impl Clone for DirectiveDefinition

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 DirectiveDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectiveDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DirectiveDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DirectiveDefinition

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 DirectiveDefinition