ShellFunctionInfo

Trait ShellFunctionInfo 

Source
pub trait ShellFunctionInfo {
    // Required methods
    fn doc_comments(&self) -> &Vec<String>;
    fn name(&self) -> String;

    // Provided method
    fn usage(&self) -> String { ... }
}
Expand description

Common properties for Rust functions exported as shell builtins.

Required Methods§

Source

fn doc_comments(&self) -> &Vec<String>

Rust documentation comments of the fn.

Source

fn name(&self) -> String

Shell function name.

Provided Methods§

Source

fn usage(&self) -> String

Shell function usage help-text.

Implementors§