Struct TableColumn 

#[non_exhaustive]
pub struct TableColumn {
    pub field: String,
    pub header: String,
    pub no_truncate: bool,
    pub nested: Option<Vec<TableColumn>>,
    pub align: Alignment,
}

Column definition for registered human table views.

Column order is a priority order, most important first: table rendering keeps this order on screen, and when the terminal is too narrow to show every column, the lowest-priority (trailing) columns are hidden first. Put the column a reader most needs — usually an id or name — first.

This declared order is only the fallback — whenever a --fields/ default_fields selection is given, its order wins instead (see crate::output::render_human_with_registry_selected), for both display and hide-priority. Declared order only governs output when no selection is given at all.

Construct with TableColumn::new, then chain builder methods like no_truncate/nested — never as a struct literal. No known consumer constructs TableColumn via struct literal, so marking it #[non_exhaustive] carries no real breaking impact today; going forward it means the engine can add fields (as it did for nested) without that becoming a breaking release either.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field: String

JSON field path. Supports simple dotted paths to reach a value nested under intermediate objects, so a column can point through a wrapper shape (a pagination envelope, a Summary<T>, etc.). A literal field name containing a . is not supported — this mirrors the dotted-path convention crate::output::fields already uses for --fields projection.

header: String

Display header.

no_truncate: bool

When true, this column’s values are never shrunk to fit the terminal (still capped at NO_TRUNCATE_MAX_WIDTH to bound pathologically long values). Use this for values that are useless when cut short, such as URLs.

nested: Option<Vec<TableColumn>>

When set, and the resolved value is list-of-objects or object shaped, this column renders as an indented child table or child property bag instead of a one-line dump — see TableColumn::nested. None (the default from TableColumn::new) is a complete no-op: rendering is identical to a column with no opinion about nesting.

align: Alignment

Header and cell text alignment — see TableColumn::align.

Implementations

impl TableColumn

pub fn new(field: impl Into<String>, header: impl Into<String>) -> Self

Creates a table column from a JSON field path and display header.

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

Opts this column out of terminal-width-driven shrinking. Values are still capped at NO_TRUNCATE_MAX_WIDTH.

pub fn align(self, alignment: Alignment) -> Self

Sets this column’s header and cell alignment. Defaults to Alignment::Left; use Alignment::Right for numeric or price columns so decimal points and digits line up instead of looking ragged on the left.

pub fn nested(self, columns: impl Into<Vec<TableColumn>>) -> Self

Opts this column into rendering a nested list/object value as an indented child table or property bag, using columns as that child’s own column definitions (which may themselves set .nested(...)).

Nesting is only consulted when this column is rendered inside an object property bag (top-level, or itself a nested property bag) — a row cell inside an array-of-objects table always renders as a single flat value, ignoring nested, because a table row is one monospace line and can’t itself contain a rendered sub-block without breaking column alignment. Recursion is otherwise unbounded through the object chain: a nested column’s own child columns may set .nested(...) again for a grandchild table or property bag.

Trait Implementations

impl Clone for TableColumn

fn clone(&self) -> TableColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableColumn

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

Formats the value using the given formatter.

impl Eq for TableColumn

impl PartialEq for TableColumn

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableColumn