Struct Table

Source

pub struct Table {
    pub headers: Vec<String>,
    pub rows: Vec<Vec<String>>,
}

Expand description

Represents a parsed table with headers and data rows.

All rows must have the same number of columns as the header. Use Table::new_validated to create a table with automatic validation.

§Examples

use table_extractor::Table;

let table = Table::new(
    vec!["id".to_string(), "name".to_string()],
    vec![
        vec!["1".to_string(), "Alice".to_string()],
        vec!["2".to_string(), "Bob".to_string()],
    ],
);

assert_eq!(table.column_count(), 2);
assert!(!table.is_empty());

Fields§

§headers: Vec<String>

Column headers

§rows: Vec<Vec<String>>

Data rows, where each row should have the same length as headers

Implementations§

Source §

impl Table

Source

pub fn new(headers: Vec<String>, rows: Vec<Vec<String>>) -> Self

Creates a new table without validation.

For safer construction with automatic validation, use Table::new_validated.

§Examples

use table_extractor::Table;

let table = Table::new(
    vec!["id".to_string(), "name".to_string()],
    vec![vec!["1".to_string(), "Alice".to_string()]],
);

Source

pub fn validate(&self) -> Result<()>

Validates that all rows have the same number of columns as headers.

§Errors

Returns error::Error::InconsistentColumns if any row has a different column count than the header.

§Examples

use table_extractor::Table;

let table = Table::new(
    vec!["id".to_string(), "name".to_string()],
    vec![
        vec!["1".to_string(), "Alice".to_string()],
        vec!["2".to_string(), "Bob".to_string()],
    ],
);

assert!(table.validate().is_ok());

// Table with inconsistent columns
let bad_table = Table::new(
    vec!["id".to_string(), "name".to_string()],
    vec![vec!["1".to_string()]], // Missing column!
);

assert!(bad_table.validate().is_err());

Source

pub fn new_validated( headers: Vec<String>, rows: Vec<Vec<String>>, ) -> Result<Self>

Creates a new table and validates it.

This is the recommended way to create a table as it ensures data integrity by validating column counts and enforcing limits.

§Errors

Returns an error if:

The number of columns exceeds 10,000 (error::Error::InvalidFormat)
Any row has a different column count than the header (error::Error::InconsistentColumns)

§Examples

use table_extractor::Table;

// Valid table
let table = Table::new_validated(
    vec!["id".to_string(), "name".to_string()],
    vec![
        vec!["1".to_string(), "Alice".to_string()],
        vec!["2".to_string(), "Bob".to_string()],
    ],
);
assert!(table.is_ok());

// Invalid table (inconsistent columns)
let bad_table = Table::new_validated(
    vec!["id".to_string(), "name".to_string()],
    vec![vec!["1".to_string()]], // Missing column!
);
assert!(bad_table.is_err());

Source

pub fn is_empty(&self) -> bool

Returns true if the table contains no data rows.

Note: A table with headers but no data rows is considered empty.

§Examples

use table_extractor::Table;

let empty_table = Table::new(
    vec!["id".to_string(), "name".to_string()],
    vec![],
);
assert!(empty_table.is_empty());

let table_with_data = Table::new(
    vec!["id".to_string(), "name".to_string()],
    vec![vec!["1".to_string(), "Alice".to_string()]],
);
assert!(!table_with_data.is_empty());

Source

pub fn column_count(&self) -> usize

Returns the number of columns in the table.

This is equivalent to the length of the headers vector.

§Examples

use table_extractor::Table;

let table = Table::new(
    vec!["id".to_string(), "name".to_string(), "email".to_string()],
    vec![],
);
assert_eq!(table.column_count(), 3);