Struct OptionList 

pub struct OptionList { /* private fields */ }

A filterable, navigable list of option labels rendered as an inline dropdown.

Implementations

impl OptionList

pub fn new(items: Vec<String>) -> OptionList

Builds a list over items, initially closed with every item matching.

pub fn open(&mut self)

Requests the dropdown be shown. Visibility is still gated on there being at least one match (see is_open).

pub fn close(&mut self)

Hides the dropdown and clears the active selection.

pub fn is_open(&self) -> bool

Whether the dropdown is currently visible (open with at least one match).

pub fn refilter(&mut self, query: &str)

Recomputes the matches for query (case-insensitive substring), resets the cursor to the top, and clears the active flag so typing re-suggests rather than committing to a highlighted row.

pub fn up(&mut self)

Moves the highlight up one row (clamped) and marks the list active.

pub fn down(&mut self)

Moves the highlight down one row (clamped) and marks the list active.

pub fn selected(&self) -> Option<&str>

The highlighted label, but only once the user has engaged the list with ↑/↓ — so a type-ahead field can tell “accept this suggestion” apart from “submit my typed text”.

pub fn set_cursor(&mut self, index: usize)

Points the cursor at the match at index (clamped) and marks the list active, used to seed a fixed-choice picker to its current value.

pub fn cursor(&self) -> usize

The highlighted position within the matches (for rendering).

pub fn match_count(&self) -> usize

The number of matches (for rendering windowing / “N more” hints).

pub fn match_labels(&self) -> impl Iterator<Item = &str>

The match labels in display order (for rendering).

Trait Implementations

impl Clone for OptionList

fn clone(&self) -> OptionList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionList

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

Formats the value using the given formatter.

impl Default for OptionList

fn default() -> OptionList

Returns the “default value” for a type.

impl Eq for OptionList

impl PartialEq for OptionList

fn eq(&self, other: &OptionList) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OptionList