Struct Table 

pub struct Table { /* private fields */ }

A decorated table with borders, headers, and separators.

Implementations

impl Table

pub fn new(spec: TabularSpec, total_width: usize) -> Self

Create a new table with the given spec and total width.

pub fn from_spec(spec: &FlatDataSpec, total_width: usize) -> Self

Create a table from a raw FlatDataSpec.

pub fn from_type<T: Tabular>(total_width: usize) -> Self

Create a table from a type that implements Tabular.

This constructor uses the TabularSpec generated by the #[derive(Tabular)] macro to configure the table.

Example

use standout::tabular::{Tabular, Table, BorderStyle};
use serde::Serialize;

#[derive(Serialize, Tabular)]
#[tabular(separator = " | ")]
struct Task {
    #[col(width = 8, header = "ID")]
    id: String,
    #[col(width = "fill", header = "Title")]
    title: String,
}

let table = Table::from_type::<Task>(80)
    .header_from_columns()
    .border(BorderStyle::Light);

pub fn border(self, border: BorderStyle) -> Self

Set the border style.

pub fn header<S: Into<String>, I: IntoIterator<Item = S>>( self, headers: I, ) -> Self

Set the column headers.

pub fn header_from_columns(self) -> Self

Set headers automatically from column specifications.

For each column, uses (in order of preference):

1. The header field if set
2. The key field if set
3. The name field if set
4. Empty string

Example

let spec = TabularSpec::builder()
    .column(Col::fixed(8).header("ID"))
    .column(Col::min(10).key("author").header("Author"))
    .column(Col::fill().named("message"))  // Uses name as fallback
    .build();

let table = Table::new(spec, 80)
    .header_from_columns()  // Headers: ["ID", "Author", "message"]
    .border(BorderStyle::Light);

pub fn header_style(self, style: impl Into<String>) -> Self

Set the header style name.

pub fn row_separator(self, enable: bool) -> Self

Enable row separators between data rows.

pub fn get_border(&self) -> BorderStyle

Get the border style.

pub fn num_columns(&self) -> usize

Get the number of columns.

pub fn row<S: AsRef<str>>(&self, values: &[S]) -> String

Format a data row.

pub fn row_from<T: Serialize>(&self, value: &T) -> String

Format a data row by extracting values from a serializable struct.

This method extracts field values based on each column’s key or name. See TabularFormatter::row_from for details on field extraction.

Example

use serde::Serialize;

#[derive(Serialize)]
struct Record { name: String, status: String }

let table = Table::new(spec, 80);
let record = Record { name: "Alice".into(), status: "active".into() };
println!("{}", table.row_from(&record));

pub fn row_from_trait<T: TabularRow>(&self, value: &T) -> String

Format a data row using the TabularRow trait.

This method uses the optimized to_row() implementation generated by #[derive(TabularRow)], avoiding JSON serialization overhead.

Example

use standout::tabular::{TabularRow, Tabular, Table, BorderStyle};

#[derive(Tabular, TabularRow)]
#[tabular(separator = " | ")]
struct Task {
    #[col(width = 8)]
    id: String,
    #[col(width = "fill")]
    title: String,
}

let table = Table::from_type::<Task>(80).border(BorderStyle::Light);
let task = Task {
    id: "TSK-001".to_string(),
    title: "Implement feature".to_string(),
};

println!("{}", table.row_from_trait(&task));

pub fn header_row(&self) -> String

Format the header row.

pub fn separator_row(&self) -> String

Generate a horizontal separator row.

pub fn top_border(&self) -> String

Generate the top border row.

pub fn bottom_border(&self) -> String

Generate the bottom border row.

pub fn render<S: AsRef<str>>(&self, rows: &[Vec<S>]) -> String

Render the complete table with all rows.

Includes top border, header (if set), separator, data rows, and bottom border.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

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

fn get_value(self: &Arc<Self>, key: &Value) -> Option<Value>

Given a key, looks up the associated value.

fn enumerate(self: &Arc<Self>) -> Enumerator

Enumerates the object.

fn call_method( self: &Arc<Self>, _state: &State<'_, '_>, name: &str, args: &[Value], ) -> Result<Value, Error>

The engine calls this to invoke a method on the object.

fn repr(self: &Arc<Self>) -> ObjectRepr

Indicates the natural representation of an object.

fn enumerator_len(self: &Arc<Self>) -> Option<usize>

Returns the length of the enumerator.

fn is_true(self: &Arc<Self>) -> bool

Returns true if this object is considered true for if conditions.

fn call( self: &Arc<Self>, state: &State<'_, '_>, args: &[Value], ) -> Result<Value, Error>

The engine calls this to invoke the object itself.

fn custom_cmp(self: &Arc<Self>, other: &DynObject) -> Option<Ordering>

Custom comparison of this object against another object of the same type.

fn render(self: &Arc<Self>, f: &mut Formatter<'_>) -> Result<(), Error>

where Self: Sized + 'static,

Formats the object for stringification.