Struct datafusion_cli::helper::CliHelper
source · [−]pub struct CliHelper { /* private fields */ }
Trait Implementations
sourceimpl Completer for CliHelper
impl Completer for CliHelper
sourcefn complete(
&self,
line: &str,
pos: usize,
ctx: &Context<'_>
) -> Result<(usize, Vec<Pair>), ReadlineError>
fn complete(
&self,
line: &str,
pos: usize,
ctx: &Context<'_>
) -> Result<(usize, Vec<Pair>), ReadlineError>
Takes the currently edited line
with the cursor pos
ition and
returns the start position and the completion candidates for the
partial word to be completed. Read more
sourcefn update(&self, line: &mut LineBuffer, start: usize, elected: &str)
fn update(&self, line: &mut LineBuffer, start: usize, elected: &str)
Updates the edited line
with the elected
candidate.
sourceimpl Highlighter for CliHelper
impl Highlighter for CliHelper
sourcefn highlight(&self, line: &'l str, pos: usize) -> Cow<'l, str>
fn highlight(&self, line: &'l str, pos: usize) -> Cow<'l, str>
Takes the currently edited line
with the cursor pos
ition and
returns the highlighted version (with ANSI color). Read more
sourcefn highlight_prompt<'b, 's, 'p>(
&'s self,
prompt: &'p str,
default: bool
) -> Cow<'b, str> where
's: 'b,
'p: 'b,
fn highlight_prompt<'b, 's, 'p>(
&'s self,
prompt: &'p str,
default: bool
) -> Cow<'b, str> where
's: 'b,
'p: 'b,
Takes the prompt
and
returns the highlighted version (with ANSI color). Read more
sourcefn highlight_hint(&self, hint: &'h str) -> Cow<'h, str>
fn highlight_hint(&self, hint: &'h str) -> Cow<'h, str>
Takes the hint
and
returns the highlighted version (with ANSI color). Read more
sourcefn highlight_candidate(
&self,
candidate: &'c str,
completion: CompletionType
) -> Cow<'c, str>
fn highlight_candidate(
&self,
candidate: &'c str,
completion: CompletionType
) -> Cow<'c, str>
Takes the completion candidate
and
returns the highlighted version (with ANSI color). Read more
sourceimpl Validator for CliHelper
impl Validator for CliHelper
sourcefn 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 more
sourcefn 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
impl Helper for CliHelper
Auto Trait Implementations
impl RefUnwindSafe for CliHelper
impl Send for CliHelper
impl Sync for CliHelper
impl Unpin for CliHelper
impl UnwindSafe for CliHelper
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more