Struct Menu

Source
pub struct Menu<I, C = NonCancellable> { /* private fields */ }

Implementations§

Source§

impl<I> Menu<I>
where I: Item,

Source

pub fn new( title: impl AsRef<str>, items: impl IntoIterator<Item = I>, ) -> Result<Self, Error>

Source§

impl<I, C> Menu<I, C>
where I: Item, for<'a> C: Cancellation<&'a I>,

Source

pub fn from_cancellation( title: impl AsRef<str>, items: impl IntoIterator<Item = I>, cancellation: C, ) -> Result<Self, Error>

Source

pub fn with_title(self, title: impl AsRef<str>) -> Self

Source

pub fn set_title(&mut self, title: impl AsRef<str>) -> &mut Self

Source

pub fn with_items( self, items: impl IntoIterator<Item = I>, ) -> Result<Self, Error>

Source

pub fn set_items( &mut self, items: impl IntoIterator<Item = I>, ) -> Result<&mut Self, Error>

Source

pub fn with_cancellation(self, cancellation: C) -> Self

Source

pub fn set_cancellation(&mut self, cancellation: C) -> &mut Self

Source

pub fn with_style(self, style: Style) -> Self

Source

pub fn set_style(&mut self, style: Style) -> &mut Self

Source

pub fn with_keybindings(self, map: KeyBindingMap) -> Self

Source

pub fn set_keybindings(&mut self, map: KeyBindingMap) -> &mut Self

Source

pub fn with_selected(self, index: usize) -> Result<Self, Error>

Source

pub fn set_selected(&mut self, index: usize) -> Result<&mut Self, Error>

Source

pub fn with_scroll(self, top_item_index: usize) -> Result<Self, Error>

Source

pub fn set_scroll(&mut self, top_item_index: usize) -> Result<&mut Self, Error>

Source

pub fn title(&self) -> &str

Source

pub fn items(&self) -> &[I]

Source

pub fn cancellation(&self) -> &C

Source

pub fn style(&self) -> &Style

Source

pub fn key_bindings(&self) -> &KeyBindingMap

Source

pub fn selected_index(&self) -> usize

Source

pub fn scroll_top_index(&self) -> usize

Source

pub fn selected_item(&self) -> &I

Source

pub fn output<'a>(&'a self) -> <C as Cancellation<&'a I>>::Output

Source

pub fn is_cancellable(&self) -> bool

Source

pub fn is_cancelling(&self) -> bool

Source

pub fn set_cancelling(&mut self, is_it: bool)

Source

pub fn run_command(&mut self, cmd: Command) -> Result<bool, Error>

Source

pub async fn run(&mut self, app: &mut App) -> Result<(), Error>

Trait Implementations§

Source§

impl<I: Clone, C: Clone> Clone for Menu<I, C>

Source§

fn clone(&self) -> Menu<I, C>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I: Debug, C: Debug> Debug for Menu<I, C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<I, C> Freeze for Menu<I, C>
where C: Freeze,

§

impl<I, C> RefUnwindSafe for Menu<I, C>

§

impl<I, C> Send for Menu<I, C>
where C: Send, I: Send,

§

impl<I, C> Sync for Menu<I, C>
where C: Sync, I: Sync,

§

impl<I, C> Unpin for Menu<I, C>
where C: Unpin, I: Unpin,

§

impl<I, C> UnwindSafe for Menu<I, C>
where C: UnwindSafe, I: UnwindSafe,

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more