Skip to main content

TableVec

Struct TableVec 

Source
pub struct TableVec<'a, T, Selection = RowSelection> { /* private fields */ }
Expand description

A table that holds a Vec of the data in its state.

ⓘ
TableVec::default()
        .widths([
            Constraint::Length(6),
            Constraint::Length(20),
            Constraint::Length(15),
            Constraint::Length(15),
            Constraint::Length(3),
        ])
        .render_cell(0, |_v, area, buf, ctx| {
            row_fmt.fmt_u(ctx.row).render(area, buf)
        })
        .render_cell(1, |v, area, buf, _ctx| v.text.render(area, buf))
        .render_cell(2, |v, area, buf, _ctx| {
            num1_fmt.fmt_u(v.num1).render(area, buf)
        })
        .render_cell(3, |v, area, buf, _ctx| {
            num2_fmt.fmt_u(v.num2).render(area, buf)
        })
        .render_cell(4, |v, area, buf, _ctx| {
            let cc = if v.check { "\u{2622}" } else { "\u{2623}" };
            cc.render(area, buf);
        })
        .column_spacing(1)
        .header(vec!["Nr", "Text", "Val1", "Val2", "State"])
        .footer(vec!["a", "b", "c", "d", "e"])
        .block(
            Block::bordered()
                .border_type(BorderType::Rounded)
                .title("tabledata-iter (no row-count)"),
        )
        .vscroll(Scroll::new())
        .styles(table(&ctx.theme))
        .render(l0[0], buf, &mut state.table);

Implementations§

Source§

impl<'a, T, Selection> TableVec<'a, T, Selection>

Source

pub fn new() -> Self
where Selection: Default,

Source

pub fn row_height(self, row_height_fn: fn(&T, &TableContext<'_>) -> u8) -> Self

A closure that calculates the row-height for a given row-value.

Source

pub fn render_row( self, render_row_fn: impl FnMut(&T, Rect, &mut Buffer, &TableContext<'_>) -> bool + 'a, ) -> Self

A closure for row-level rendering. The area covers the full row.

Return

Returns true if the individual cells should be rendered too.

Source

pub fn render_cell( self, column: usize, render_cell_fn: impl FnMut(&T, Rect, &mut Buffer, &TableContext<'_>) + 'a, ) -> Self

A closure for rendering a single column.

The area covers the exact column. Extra information is available in the TableContext.

The given Buffer covers the full row so you could render something outside the cells bounds. Cells for a given row are always rendered in ascending order.

Source

pub fn header<I>(self, header: I) -> Self
where I: IntoIterator, I::Item: Into<Text<'a>>,

Set the table-header.

Source

pub fn footer<I>(self, footer: I) -> Self
where I: IntoIterator, I::Item: Into<Text<'a>>,

Set the table-footer.

Source

pub fn widths<I>(self, widths: I) -> Self

Column widths as Constraints.

The constraints work in tandem with Table::layout_width.

Source

pub fn varying_heights(self, varying: bool) -> Self

If your table uses varying row-heights for each row all page calculations will fail (somewhat). If you enable this flag, the row-heights for each row will be stored in the state to allow accurate page-calculations.

Source

pub fn flex(self, flex: Flex) -> Self

Flex-value for column layout.

Source

pub fn column_spacing(self, spacing: u16) -> Self

Spacing between columns.

Source

pub fn layout_width(self, width: LayoutWidth) -> Self

Set the display width of the table.

Default The width of the rendered area is used.

Source

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

Draws a block around the table widget.

Source

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

Sets the border-style for the Block, if any.

Source

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

Sets the title-style for the Block, if any.

Source

pub fn scroll(self, scroll: Scroll<'a>) -> Self

Scrollbars

Source

pub fn hscroll(self, scroll: Scroll<'a>) -> Self

Scrollbars

Source

pub fn vscroll(self, scroll: Scroll<'a>) -> Self

Scrollbars

Source

pub fn styles(self, styles: TableStyle) -> Self

Set all styles as a bundle.

Source

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

Base style for the table.

Source

pub fn header_style(self, style: Option<Style>) -> Self

Base style for the table.

Source

pub fn footer_style(self, style: Option<Style>) -> Self

Base style for the table.

Source

pub fn select_row_style(self, select_style: Option<Style>) -> Self

Style for a selected row. The chosen selection must support row-selection for this to take effect.

Source

pub fn show_row_focus(self, show: bool) -> Self

Add the focus-style to the row-style if the table is focused.

Source

pub fn select_column_style(self, select_style: Option<Style>) -> Self

Style for a selected column. The chosen selection must support column-selection for this to take effect.

Source

pub fn show_column_focus(self, show: bool) -> Self

Add the focus-style to the column-style if the table is focused.

Source

pub fn select_cell_style(self, select_style: Option<Style>) -> Self

Style for a selected cell. The chosen selection must support cell-selection for this to take effect.

Source

pub fn show_cell_focus(self, show: bool) -> Self

Add the focus-style to the cell-style if the table is focused.

Source

pub fn select_header_style(self, select_style: Option<Style>) -> Self

Style for a selected header cell. The chosen selection must support column-selection for this to take effect.

Source

pub fn show_header_focus(self, show: bool) -> Self

Add the focus-style to the header-style if the table is focused.

Style for a selected footer cell. The chosen selection must support column-selection for this to take effect.

Add the footer-style to the table-style if the table is focused.

Source

pub fn focus_style(self, focus_style: Option<Style>) -> Self

This style will be patched onto the selection to indicate that the widget has the input focus.

The selection must support some kind of selection for this to be effective.

Source

pub fn width(&self) -> u16

Inherent width.

Source

pub fn height(&self) -> u16

Inherent height.

Source§

impl<'a, 'b, T, Selection> TableVec<'a, T, Selection>
where Selection: TableSelection + Default, 'b: 'a,

Source

pub fn render( self, area: Rect, buf: &mut Buffer, state: &'b mut TableVecState<T, Selection>, )

Trait Implementations§

Source§

impl<'a, T, Selection> Default for TableVec<'a, T, Selection>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<'a, T, Selection = RowSelection> !RefUnwindSafe for TableVec<'a, T, Selection>

§

impl<'a, T, Selection = RowSelection> !Send for TableVec<'a, T, Selection>

§

impl<'a, T, Selection = RowSelection> !Sync for TableVec<'a, T, Selection>

§

impl<'a, T, Selection = RowSelection> !UnwindSafe for TableVec<'a, T, Selection>

§

impl<'a, T, Selection> Forget for TableVec<'a, T, Selection>

§

impl<'a, T, Selection> Freeze for TableVec<'a, T, Selection>
where Table<'a, &'a T, Selection>: Freeze,

§

impl<'a, T, Selection> Unpin for TableVec<'a, T, Selection>
where Table<'a, &'a T, Selection>: Unpin,

§

impl<'a, T, Selection> UnsafeUnpin for TableVec<'a, T, Selection>
where Table<'a, &'a T, Selection>: UnsafeUnpin,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.