Enum ReplDirective 

#[non_exhaustive]
pub enum ReplDirective {
    Help,
    Load,
    Quit,
    Exit,
}

Framework directive available in the REPL

Deserialized from the implementation field of a directives: entry (repl_help, repl_load, repl_quit, repl_exit). An unknown value fails at load time, and the error lists the accepted values.

The enum is #[non_exhaustive]: later versions may add directives.

Example

use dynamic_cli::config::ReplDirective;

assert_eq!(ReplDirective::Help.default_name(), "help");
assert_eq!(ReplDirective::Help.default_aliases(), &["h", "?"]);
assert_eq!(ReplDirective::Help.usage(), "[command]");
assert_eq!(ReplDirective::Help.as_str(), "repl_help");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Help

Show the application help, or the help of one command

Load

Run every line of a script file in the current session

Quit

Save the session history, then leave the REPL

Exit

Leave the REPL without saving the session history

Implementations

impl ReplDirective

pub const ALL: &'static [ReplDirective]

Every directive, in the order used by effective_directives and by help listings

pub fn as_str(self) -> &'static str

Identifier used in the implementation field of the configuration

pub fn default_name(self) -> &'static str

Name used when the configuration does not override the directive

pub fn default_aliases(self) -> &'static [&'static str]

Aliases used when the configuration does not override the directive

pub fn default_description(self) -> &'static str

Description used when the configuration does not override the directive

pub fn usage(self) -> &'static str

Arguments accepted after the directive name, as shown in help

Returns only the argument part, since the name itself may be overridden; the result is empty for a directive without arguments. Arguments are fixed by the action and cannot be configured.

Trait Implementations

impl Clone for ReplDirective

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReplDirective

impl Debug for ReplDirective

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReplDirective

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReplDirective

impl Hash for ReplDirective

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReplDirective

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReplDirective

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 ReplDirective