Struct SelectState 

pub struct SelectState { /* private fields */ }

The state for a SelectPrompt.

Rendering a SelectPrompt keeps the focused index within the rendered options. Until the prompt has been rendered at least once, explicit focused-index changes are accepted and clamped on the next render. Once the state is completed or aborted, SelectState::handle_key_event ignores later key events.

Implementations

impl SelectState

pub const fn new() -> SelectState

Creates a pending, unfocused select state.

pub fn move_up(&mut self)

Moves focus to the previous option.

Focus stays at index 0 when the first option is already focused.

pub fn move_down(&mut self)

Moves focus to the next option.

Focus stays at the last rendered option. The prompt learns the option count during render, so this is a no-op until the state has been rendered with at least one visible option.

pub const fn with_status(self, status: Status) -> SelectState

Sets the prompt status.

pub const fn with_focus(self, focus: FocusState) -> SelectState

Sets whether the prompt is focused.

pub const fn focused_index(&self) -> usize

Returns the currently focused option index.

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

Sets the focused option index.

If the state has already been rendered with options, the index is clamped to the last available option. If the state has not been rendered yet, the value is accepted and clamped during the next render.

pub const fn is_finished(&self) -> bool

Returns whether the select prompt has completed or aborted.

pub const fn status(&self) -> Status

Returns the current prompt status.

pub fn focus(&mut self)

Sets focus to FocusState::Focused.

pub fn blur(&mut self)

Sets focus to FocusState::Unfocused.

pub fn is_focused(&self) -> bool

Returns whether the select prompt is focused.

pub fn complete(&mut self)

Completes the prompt.

pub fn abort(&mut self)

Aborts the prompt.

pub fn handle_key_event(&mut self, key: KeyEvent)

Handles a key event for select prompt navigation and completion.

Pressing Up or Down moves the focused option, Enter completes the prompt when an option is visible, and Escape or Ctrl+C aborts the prompt. Key release events and events routed after completion or abort are ignored.

Trait Implementations

impl Clone for SelectState

fn clone(&self) -> SelectState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectState

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

Formats the value using the given formatter.

impl Default for SelectState

fn default() -> SelectState

Returns the “default value” for a type.

impl Eq for SelectState

impl Hash for SelectState

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SelectState

fn eq(&self, other: &SelectState) -> 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 SelectState