FlatDataSpec

Struct FlatDataSpec 

Source
pub struct FlatDataSpec {
    pub columns: Vec<Column>,
    pub decorations: Decorations,
}
Expand description

Complete specification for a flat data layout (Table or CSV).

Fields§

§columns: Vec<Column>

Column specifications.

§decorations: Decorations

Row decorations (separators, prefix, suffix).

Implementations§

Source§

impl FlatDataSpec

Source

pub fn resolve_widths(&self, total_width: usize) -> ResolvedWidths

Resolve column widths without examining data.

This uses minimum widths for Bounded columns and allocates remaining space to Fill columns. Use resolve_widths_from_data for data-driven width calculation.

§Arguments
  • total_width - Total available width including decorations
Source

pub fn resolve_widths_from_data<S: AsRef<str>>( &self, total_width: usize, data: &[Vec<S>], ) -> ResolvedWidths

Resolve column widths by examining data to determine optimal widths.

For Bounded columns, scans the data to find the actual maximum width needed, then clamps to the specified bounds. Fill columns receive remaining space after all other columns are resolved.

§Arguments
  • total_width - Total available width including decorations
  • data - Row data where each row is a slice of cell values
§Example
use standout::tabular::{FlatDataSpec, Column, Width};

let spec = FlatDataSpec::builder()
    .column(Column::new(Width::Bounded { min: Some(5), max: Some(20) }))
    .column(Column::new(Width::Fill))
    .separator("  ")
    .build();

let data: Vec<Vec<&str>> = vec![
    vec!["short", "description"],
    vec!["longer value", "another"],
];
let widths = spec.resolve_widths_from_data(80, &data);
Source§

impl FlatDataSpec

Source

pub fn new(columns: Vec<Column>) -> Self

Create a new spec with the given columns and default decorations.

Source

pub fn builder() -> FlatDataSpecBuilder

Create a spec builder.

Source

pub fn num_columns(&self) -> usize

Get the number of columns.

Source

pub fn has_fill_column(&self) -> bool

Check if any column uses Fill width.

Source

pub fn extract_header(&self) -> Vec<String>

Extract a header row from the spec.

Uses column header if present, otherwise key, otherwise empty string.

Source

pub fn extract_row(&self, data: &Value) -> Vec<String>

Extract a data row from a JSON value using the spec.

For each column:

  • If key is set, traverses the JSON to find the value.
  • If key is unset/missing, uses null_repr.
  • Handles nested objects via dot notation (e.g. “author.name”).

Trait Implementations§

Source§

impl Clone for FlatDataSpec

Source§

fn clone(&self) -> FlatDataSpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlatDataSpec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more