Struct SearchListBuilder 

pub struct SearchListBuilder<R: SearchRow> { /* private fields */ }

Implementations

impl<R: SearchRow> SearchListBuilder<R>

pub fn initial_query(self, q: impl Into<String>) -> Self

pub fn filter(self, f: Filter<R>) -> Self

pub fn order_by(self, cmp: OrderFn<R>) -> Self

Keep the rows in this order regardless of arrival order. Composes with any Filter: with an empty query the order is the display order; under Fuzzy it decides ties between equally-scored matches. Change it later with SearchList::set_order.

pub fn autocomplete( self, suggestions: Arc<dyn SuggestionSource>, mode: AutocompleteMode, ) -> Self

pub fn yank_combos_from(self, bindings: &KeyBindings) -> Self

Bind the yank chord to whatever the user has bound ActionShortcuts::YankRow to. Surfaces that hold KeyBindings should always call this — the builder default is only for those that do not (and for tests).

pub fn yank_combos(self, combos: Vec<KeyCombo>) -> Self

Override the yank chords directly (see Self::yank_combos_from). An empty list disables the chord for this surface.

pub fn intercept(self, v: Vec<KeyCombo>) -> Self

pub fn highlight_query(self) -> Self

Render the query input with §9 syntax highlighting.

pub fn icons(self, icons: Icons) -> Self

pub fn opening_focus(self, focus: Focus) -> Self

The focus the surface opens on (default Focus::Input). Opening on Focus::List also activates the list-focus state machine (so Esc cancels from the list rather than flipping into it).

pub fn list_verb(self, c: char) -> Self

Register a plain letter as a list-focus verb. In Focus::List, pressing it returns KeyReaction::ListVerb with the char; the engine attaches no meaning — the caller decides the action. Registering any verb activates the list-focus state machine. j/k/i// are reserved (navigation and focus switching) and win over a same-letter verb.

pub fn debounce(self, d: Duration) -> Self

Override the autocomplete controller’s debounce. Tests use Duration::ZERO to get suggestions without waiting on the debounce timer.

pub fn build(self) -> SearchList<R>

pub fn build_with_rows(self, rows: Vec<R>) -> SearchList<R>

Build synchronously over a known, in-memory row set: the rows are applied and the initial selection seeded before this returns — no async load, no channel, no redraw round-trip. For static sources (reload_on_query() == false); the source’s load is never called, so most static consumers pair this with StaticRowSource. The redraw callback passed to builder is never fired on this path.