Skip to main content

List

Struct List 

Source
pub struct List<'b, L>
where L: Iterator<Item = Text<'b>>,
{ /* private fields */ }
Expand description

A widget to display several items among which one can be selected (optional)

§Examples

let items = ["Item 1", "Item 2", "Item 3"].iter().map(|i| Text::raw(*i));
List::new(items)
    .block(Block::default().title("List").borders(Borders::ALL))
    .style(Style::default().fg(Color::White))
    .highlight_style(Style::default().modifier(Modifier::ITALIC))
    .highlight_symbol(">>");

Implementations§

Source§

impl<'b, L> List<'b, L>
where L: Iterator<Item = Text<'b>>,

Source

pub fn new(items: L) -> List<'b, L>

Source

pub fn block(self, block: Block<'b>) -> List<'b, L>

Source

pub fn items<I>(self, items: I) -> List<'b, L>
where I: IntoIterator<Item = Text<'b>, IntoIter = L>,

Source

pub fn style(self, style: Style) -> List<'b, L>

Source

pub fn highlight_symbol(self, highlight_symbol: &'b str) -> List<'b, L>

Source

pub fn highlight_style(self, highlight_style: Style) -> List<'b, L>

Source

pub fn start_corner(self, corner: Corner) -> List<'b, L>

Trait Implementations§

Source§

impl<'b, L> Default for List<'b, L>
where L: Iterator<Item = Text<'b>> + Default,

Source§

fn default() -> List<'b, L>

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

impl<'b, L> StatefulWidget for List<'b, L>
where L: Iterator<Item = Text<'b>>,

Source§

type State = ListState

Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Source§

impl<'b, L> Widget for List<'b, L>
where L: Iterator<Item = Text<'b>>,

Source§

fn render(self, area: Rect, buf: &mut Buffer)

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

Auto Trait Implementations§

§

impl<'b, L> Freeze for List<'b, L>
where L: Freeze,

§

impl<'b, L> RefUnwindSafe for List<'b, L>
where L: RefUnwindSafe,

§

impl<'b, L> Send for List<'b, L>
where L: Send,

§

impl<'b, L> Sync for List<'b, L>
where L: Sync,

§

impl<'b, L> Unpin for List<'b, L>
where L: Unpin,

§

impl<'b, L> UnsafeUnpin for List<'b, L>
where L: UnsafeUnpin,

§

impl<'b, L> UnwindSafe for List<'b, L>
where L: 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> 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, 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.