Struct CqlCompleter 

pub struct CqlCompleter {
    cache: Arc<RwLock<SchemaCache>>,
    current_keyspace: Arc<RwLock<Option<String>>>,
    rt_handle: Handle,
    colorizer: CqlColorizer,
}

Tab completer for the CQL shell REPL.

Fields

cache: Arc<RwLock<SchemaCache>>

Shared schema cache for keyspace/table/column lookups.

current_keyspace: Arc<RwLock<Option<String>>>

Current keyspace (shared with session via USE command).

rt_handle: Handle

Tokio runtime handle for blocking cache reads inside sync complete().

colorizer: CqlColorizer

Syntax colorizer for highlighting.

Implementations

impl CqlCompleter

pub fn new( cache: Arc<RwLock<SchemaCache>>, current_keyspace: Arc<RwLock<Option<String>>>, rt_handle: Handle, color_enabled: bool, ) -> Self

Create a new completer with shared cache and keyspace state.

fn detect_context(&self, line: &str, pos: usize) -> CompletionContext

Detect completion context from the input line up to the cursor position.

fn complete_for_context( &self, ctx: &CompletionContext, prefix: &str, ) -> Vec<Pair>

Generate completions for the detected context.

Trait Implementations

impl Completer for CqlCompleter

type Candidate = Pair

Specific completion candidate.

fn complete( &self, line: &str, pos: usize, _ctx: &Context<'_>, ) -> Result<(usize, Vec<Pair>)>

Takes the currently edited line with the cursor position and returns the start position and the completion candidates for the partial word to be completed.

fn update( &self, line: &mut LineBuffer, start: usize, elected: &str, cl: &mut Changeset, )

Updates the edited line with the elected candidate.

impl Highlighter for CqlCompleter

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).

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).

fn highlight_char(&self, _line: &str, _pos: usize, _forced: CmdKind) -> bool

Tells if line needs to be highlighted when a specific char is typed or when cursor is moved under a specific char.

fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str>

Takes the hint and returns the highlighted version (with ANSI color).

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).

impl Hinter for CqlCompleter

type Hint = String

Specific hint type

fn hint(&self, _line: &str, _pos: usize, _ctx: &Context<'_>) -> Option<String>

Takes the currently edited line with the cursor position and returns the string that should be displayed or None if no hint is available for the text the user currently typed.

impl Validator for CqlCompleter

fn validate( &self, ctx: &mut ValidationContext<'_>, ) -> Result<ValidationResult, ReadlineError>

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.

fn validate_while_typing(&self) -> bool

Configure whether validation is performed while typing or only when user presses the Enter key.

impl Helper for CqlCompleter