Skip to main content

SelectPrompt

Struct SelectPrompt 

Source
pub struct SelectPrompt<'a> { /* private fields */ }
Expand description

A prompt widget for choosing one option from a list.

SelectPrompt owns the label and options to render, while SelectState tracks the focused option, focus state, and completion status. Render the prompt before routing key events so the state can learn how many options are currently selectable.

When the render area is shorter than the option list, the prompt renders a window around the focused option so the highlighted row remains visible.

Implementations§

Source§

impl<'a> SelectPrompt<'a>

Source

pub const fn new( label: Cow<'a, str>, options: SelectOptionList<'a>, ) -> SelectPrompt<'a>

Creates a select prompt from a label and an ordered option list.

Source

pub fn with_block(self, block: Block<'a>) -> SelectPrompt<'a>

Wraps the prompt in a Block.

Trait Implementations§

Source§

impl<'a> Clone for SelectPrompt<'a>

Source§

fn clone(&self) -> SelectPrompt<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for SelectPrompt<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for SelectPrompt<'a>

Source§

fn default() -> SelectPrompt<'a>

Returns the “default value” for a type. Read more
Source§

impl<'a> Eq for SelectPrompt<'a>

Source§

impl<'a> PartialEq for SelectPrompt<'a>

Source§

fn eq(&self, other: &SelectPrompt<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Prompt for SelectPrompt<'_>

Source§

fn draw( self, frame: &mut Frame<'_>, area: Rect, state: &mut <SelectPrompt<'_> as StatefulWidget>::State, )

Draws the prompt widget. Read more
Source§

impl<'a> StatefulWidget for SelectPrompt<'a>

Source§

type State = SelectState

State associated with the stateful widget. Read more
Source§

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <SelectPrompt<'a> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.
Source§

impl<'a> StructuralPartialEq for SelectPrompt<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for SelectPrompt<'a>

§

impl<'a> !Send for SelectPrompt<'a>

§

impl<'a> !Sync for SelectPrompt<'a>

§

impl<'a> !UnwindSafe for SelectPrompt<'a>

§

impl<'a> Freeze for SelectPrompt<'a>

§

impl<'a> Unpin for SelectPrompt<'a>

§

impl<'a> UnsafeUnpin for SelectPrompt<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.