pub struct CommandHelper { /* private fields */ }Implementations§
Source§impl CommandHelper
impl CommandHelper
Sourcepub fn with_commands(
command_names: Vec<String>,
subcommands: HashMap<String, Vec<String>>,
) -> Self
pub fn with_commands( command_names: Vec<String>, subcommands: HashMap<String, Vec<String>>, ) -> Self
Create a CommandHelper populated with command names and subcommand
completions, typically sourced from the binary’s CommandRegistry.
command_names: all slash-command names (primary + aliases), e.g."/help","/quit".subcommands: mapping from command name to its argument completions, e.g."/mode" → ["agent", "casual", "planning"].
Trait Implementations§
Source§impl Completer for CommandHelper
impl Completer for CommandHelper
Source§impl Default for CommandHelper
impl Default for CommandHelper
impl Helper for CommandHelper
Source§impl Highlighter for CommandHelper
impl Highlighter for CommandHelper
Source§fn highlight<'l>(&self, line: &'l str, pos: usize) -> Cow<'l, str>
fn highlight<'l>(&self, line: &'l str, pos: usize) -> Cow<'l, str>
Takes the currently edited
line with the cursor position and
returns the highlighted version (with ANSI color). Read moreSource§fn highlight_prompt<'b, 's: 'b, 'p: 'b>(
&'s self,
prompt: &'p str,
default: bool,
) -> Cow<'b, str>
fn highlight_prompt<'b, 's: 'b, 'p: 'b>( &'s self, prompt: &'p str, default: bool, ) -> Cow<'b, str>
Takes the
prompt and
returns the highlighted version (with ANSI color).Source§fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str>
fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str>
Takes the
hint and
returns the highlighted version (with ANSI color).Source§fn highlight_candidate<'c>(
&self,
candidate: &'c str,
completion: CompletionType,
) -> Cow<'c, str>
fn highlight_candidate<'c>( &self, candidate: &'c str, completion: CompletionType, ) -> Cow<'c, str>
Takes the completion
candidate and
returns the highlighted version (with ANSI color). Read moreSource§impl Hinter for CommandHelper
impl Hinter for CommandHelper
Source§impl Validator for CommandHelper
impl Validator for CommandHelper
Source§fn validate(&self, ctx: &mut ValidationContext<'_>) -> Result<ValidationResult>
fn validate(&self, ctx: &mut ValidationContext<'_>) -> Result<ValidationResult>
Takes the currently edited
input and returns a
ValidationResult indicating whether it is valid or not along
with an option message to display about the result. The most
common validity check to implement is probably whether the
input is complete or not, for instance ensuring that all
delimiters are fully balanced. Read moreSource§fn validate_while_typing(&self) -> bool
fn validate_while_typing(&self) -> bool
Configure whether validation is performed while typing or only
when user presses the Enter key. Read more
Auto Trait Implementations§
impl Forget for CommandHelper
impl Freeze for CommandHelper
impl RefUnwindSafe for CommandHelper
impl Send for CommandHelper
impl Sync for CommandHelper
impl Unpin for CommandHelper
impl UnsafeUnpin for CommandHelper
impl UnwindSafe for CommandHelper
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more