Skip to main content

Table

Struct Table 

Source
pub struct Table {
Show 23 fields pub title: Option<String>, pub caption: Option<String>, pub box_style: BoxStyle, pub show_header: bool, pub show_footer: bool, pub show_edge: bool, pub show_lines: bool, pub padding: (usize, usize, usize, usize), pub collapse_padding: bool, pub style: Style, pub border_style: Style, pub title_style: Style, pub caption_style: Style, pub title_justify: AlignMethod, pub caption_justify: AlignMethod, pub highlight: bool, pub width: Option<usize>, pub row_styles: Vec<Style>, pub leading: usize, pub rowspans: Vec<usize>, pub section_rows: HashSet<usize>, pub pad_edge: bool, pub sections: Vec<usize>, /* private fields */
}
Expand description

A renderable for tabular data.

Fields§

§title: Option<String>

Title above the table.

§caption: Option<String>

Caption below the table.

§box_style: BoxStyle

Box style.

§show_header: bool

Show the header row.

§show_footer: bool

Show the footer row.

§show_edge: bool

Show outer edge border.

§show_lines: bool

Show lines between every row.

§padding: (usize, usize, usize, usize)

Padding per cell (top, right, bottom, left).

§collapse_padding: bool

Collapse padding between rows.

§style: Style

Default style for the table.

§border_style: Style

Border style.

§title_style: Style

Title style.

§caption_style: Style

Caption style.

§title_justify: AlignMethod

Title justification.

§caption_justify: AlignMethod

Caption justification.

§highlight: bool

If true, highlight cell strings.

§width: Option<usize>

Optional fixed width.

§row_styles: Vec<Style>

Row styles (alternating).

§leading: usize

Number of blank lines between rows.

§rowspans: Vec<usize>

Active rowspan counts per column (tracked during rendering).

§section_rows: HashSet<usize>

Row indices that have a section separator before them.

§pad_edge: bool

Pad the outer edge of the table (left of first column, right of last).

§sections: Vec<usize>

Row indices where sections end (ordered, in insertion order).

Implementations§

Source§

impl Table

Source

pub fn new() -> Self

Create a new Table.

Source

pub fn add_column(&mut self, column: Column)

Add a column definition to the table.

Columns must be added before rows are populated.

§Examples
use rusty_rich::{Table, Column};

let mut table = Table::new();
table.add_column(Column::new("Name"));
table.add_column(Column::new("Age"));
Source

pub fn add_row(&mut self, row: Vec<Cell>)

Add a row from Cell objects (supports colspan/rowspan).

§Examples
use rusty_rich::{Table, Column, Cell};

let mut table = Table::new();
table.add_column(Column::new("A"));
table.add_column(Column::new("B"));
table.add_row(vec![Cell::new("data").colspan(2)]);
Source

pub fn add_row_explicit(&mut self, row: Row) -> &mut Self

Add a pre-built Row object, which may carry a style and section information.

If the row has end_section set to true, a section divider is inserted before this row.

Source

pub fn add_row_str(&mut self, row: Vec<String>)

Add a row from plain strings (backward-compatible, converts to Cells).

§Examples
use rusty_rich::{Table, Column};

let mut table = Table::new();
table.add_column(Column::new("Name"));
table.add_column(Column::new("Age"));
table.add_row_str(vec!["Alice".into(), "30".into()]);
Source

pub fn column(self, col: Column) -> Self

Builder: add a column and return self.

Source

pub fn row(self, row: Vec<Cell>) -> Self

Builder: add a row of Cells and return self.

Source

pub fn row_str(self, row: Vec<String>) -> Self

Builder: add a row of strings and return self.

Source

pub fn row_explicit(self, row: Row) -> Self

Builder: add a pre-built Row and return self.

Source

pub fn title(self, t: impl Into<String>) -> Self

Builder: set title.

Source

pub fn caption(self, t: impl Into<String>) -> Self

Builder: set caption.

Source

pub fn box_style(self, bs: BoxStyle) -> Self

Builder: set box style.

Source

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

Builder: set border style.

Source

pub fn hide_header(self) -> Self

Builder: hide the header.

Source

pub fn show_lines(self) -> Self

Builder: show lines.

Source

pub fn leading(self, l: usize) -> Self

Builder: set leading (blank lines between rows).

Source

pub fn highlight(self, value: bool) -> Self

Builder: enable row highlighting.

Source

pub fn title_justify(self, justify: AlignMethod) -> Self

Builder: set title alignment.

Source

pub fn caption_justify(self, justify: AlignMethod) -> Self

Builder: set caption alignment.

Source

pub fn row_styles(self, styles: Vec<Style>) -> Self

Builder: set alternating row styles.

Source

pub fn show_edge(self, value: bool) -> Self

Builder: show/hide outer edge border.

Source

pub fn collapse_padding(self, value: bool) -> Self

Builder: collapse padding between cells.

Source

pub fn pad_edge(self, value: bool) -> Self

Builder: pad the outer edge of the table.

Source

pub fn get_row_style(&self, row_index: usize) -> Option<Style>

Get the style for a specific row (cycling through row_styles if set).

Source

pub fn grid() -> Self

Create a grid table (no outer border, no header, no footer). Equivalent to Table.grid().

Source

pub fn add_section(&mut self) -> &mut Self

Add a section separator before the next row. The next row added will have a horizontal rule above it. Returns &mut Self for chaining.

Source

pub fn row_count(&self) -> usize

Get the row count.

Trait Implementations§

Source§

impl Clone for Table

Source§

fn clone(&self) -> Table

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 Debug for Table

Source§

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

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

impl Default for Table

Source§

fn default() -> Self

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

impl Renderable for Table

Source§

fn render(&self, options: &ConsoleOptions) -> RenderResult

Render this object into a RenderResult using the provided options. Read more
Source§

fn measure(&self, _options: &ConsoleOptions) -> Option<Measurement>

Optional width-measurement hook (equivalent to __rich_measure__). Override to provide min/max width constraints for layout.

Auto Trait Implementations§

§

impl Freeze for Table

§

impl RefUnwindSafe for Table

§

impl Send for Table

§

impl Sync for Table

§

impl Unpin for Table

§

impl UnsafeUnpin for Table

§

impl UnwindSafe for Table

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
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, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
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, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.