Struct Completion 

#[non_exhaustive]
pub struct Completion {
    pub anchor_row: usize,
    pub anchor_col: usize,
    pub all_items: Vec<CompletionItem>,
    pub visible: Vec<usize>,
    pub selected: usize,
    pub prefix: String,
    /* private fields */
}

Active completion popup state.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

anchor_row: usize

Cursor row (0-based) when the popup was opened.

anchor_col: usize

Cursor column (0-based) when the popup was opened.

all_items: Vec<CompletionItem>

All items returned by the server (unfiltered).

visible: Vec<usize>

Indices into all_items that survive the current prefix filter.

selected: usize

Selected index into visible.

prefix: String

Prefix the user has typed since the popup was opened.

Implementations

impl Completion

pub fn new( anchor_row: usize, anchor_col: usize, items: Vec<CompletionItem>, ) -> Self

Create a new popup anchored at (anchor_row, anchor_col) with the given item list. All items are immediately visible (empty prefix).

Example

use hjkl_completion::{Completion, CompletionItem};

let popup = Completion::new(1, 5, vec![CompletionItem::new("foo")]);
assert_eq!(popup.anchor_row, 1);
assert_eq!(popup.anchor_col, 5);
assert_eq!(popup.visible.len(), 1);

pub fn set_prefix(&mut self, prefix: &str)

Refilter visible items using a case-insensitive subsequence match against prefix, ranked by match quality (best first): an exact match outranks a prefix match, which outranks a contiguous run, which outranks a scattered subsequence; shorter candidates and earlier / more word-boundary-aligned matches score higher. Ties keep the original (server-provided) order for stability. Resets selected to 0 so the best match is auto-selected.

pub fn select_next(&mut self)

Move selection down one step, wrapping at the end.

pub fn select_prev(&mut self)

Move selection up one step, wrapping at the start.

pub fn note_flip(&self, flipped: bool)

Record whether the view drew this popup flipped (above the anchor). Called by the renderer each frame; navigation then mirrors accordingly.

pub fn is_flipped(&self) -> bool

true when the popup was last rendered above the anchor line.

pub fn cycle_down(&mut self)

Move the highlight one row down on screen, regardless of orientation. When not flipped, visual order == logical order, so this is select_next. When flipped, the list is drawn inverted (best match at the bottom), so moving down visually means stepping to the previous logical item.

pub fn cycle_up(&mut self)

Move the highlight one row up on screen, regardless of orientation. Inverse of Self::cycle_down.

pub fn selected_item(&self) -> Option<&CompletionItem>

Return the currently selected item, if any.

pub fn is_empty(&self) -> bool

True when no items match the current prefix — popup should auto-dismiss.

Trait Implementations

impl Clone for Completion

fn clone(&self) -> Completion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Completion

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

Formats the value using the given formatter.

impl Default for Completion

fn default() -> Self

Returns the “default value” for a type.