Struct Table 

pub struct Table { /* private fields */ }

Available on crate feature document only.

Rows of cells under an optional header row.

The table has as many columns as its longest row or its header row. A shorter row gets empty cells. Column marks, such as Self::id_column, choose the role of a column’s plain cells and how it is cut or aligned.

use ctl_core::document::Table;

let table = Table::new(["id", "title", "age"])
    .id_column(0)
    .ellipsis_column(1)
    .numeric_column(2)
    .row(["A-1", "Ship the release", "3"]);
assert_eq!(table.rows().len(), 1);
assert_eq!(table.id_column_index(), Some(0));

Implementations

impl Table

pub fn plain() -> Self

Start a table with no header row.

pub fn new(headers: impl IntoIterator<Item = impl Into<Text>>) -> Self

Start a table with one header cell per item of headers.

pub const fn token_column(self, index: usize) -> Self

Draw the plain cells of column index (counted from 0) as Role::Token.

pub const fn id_column(self, index: usize) -> Self

Draw the plain cells of column index (counted from 0) as Role::Id.

pub fn ellipsis_column(self, index: usize) -> Self

Mark column index (counted from 0) as text that may be cut short.

A cell too wide for its column keeps one line and ends in …. The column gives up its width before a column of whole words does. Use it for a title or a summary, never for a value a reader copies out, such as a URL or a path. Call it once per column.

pub fn numeric_column(self, index: usize) -> Self

Mark column index (counted from 0) as numbers.

Every cell of the column, header included, aligns right, so numbers line up on their last digit. Call it once per column.

pub const fn stacked_below(self, width: u16, label_columns: usize) -> Self

Stack each row when the available width is below width cells.

The first label_columns cells of a row form its label line. The remaining cells form the indented description under it. The label cells are drawn as Role::Token.

pub fn row(self, cells: impl IntoIterator<Item = impl Into<Text>>) -> Self

Append a row of cells, one per item.

pub fn headers(&self) -> &[Text]

The header cells, empty for a table with no header row.

pub fn rows(&self) -> &[Vec<Text>]

The body rows, in the order appended.

pub const fn token_column_index(&self) -> Option<usize>

The column set by Self::token_column, if any.

pub const fn id_column_index(&self) -> Option<usize>

The column set by Self::id_column, if any.

pub fn ellipsis_columns(&self) -> &[usize]

Columns marked with Self::ellipsis_column, in the order marked.

pub fn numeric_columns(&self) -> &[usize]

Columns marked with Self::numeric_column, in the order marked.

pub const fn stacked(&self) -> Option<Stacked>

The narrow-layout policy set by Self::stacked_below, if any.

pub fn is_empty(&self) -> bool

Whether the table has no body rows. A header row does not count.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Table

impl From<Table> for Block

fn from(value: Table) -> Self

Converts to this type from the input type.

impl PartialEq for Table

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Table