Struct Table

Source

#[repr(C, align(64))]pub struct Table {
    pub cols: Vec<FieldArray>,
    pub n_rows: usize,
    pub name: String,
}

Expand description

§Table

§Description

Standard columnar table with named columns (FieldArray), a fixed number of rows, and an optional logical table name.
All columns are required to be equal length and have consistent schema.
Supports zero-copy slicing, efficient iteration, and bulk operations.
Equivalent to the RecordBatch in Apache Arrow.

§Structure

cols: A vector of FieldArray, each representing a column with metadata and data.
n_rows: The logical number of rows (guaranteed equal for all columns).
name: Optional logical name or alias for this table instance.

§Usage

Use Table as a general-purpose, in-memory columnar data container.
Good for analytics, and transformation pipelines.
For batched/partitioned tables, see SuperTable or windowed/chunked abstractions.
Cast into Polars dataframe via .to_polars() or Apache Arrow via .to_apache_arrow()
FFI-compatible

§Notes

Table instances are typically lightweight to clone and pass by value.
For mutation, construct a new table or replace individual columns as needed.
There is an alias RecordBatch under crate::aliases::RecordBatch

§Example

use minarrow::{fa_i32, fa_str32, Print, Table};

let col1 = fa_i32!("numbers", 1, 2, 3);
let col2 = fa_str32!("letters", "x", "y", "z");

let mut tbl = Table::new("Demo".into(), vec![col1, col2].into());
tbl.print();

Fields§

§cols: Vec<FieldArray>

FieldArrays representing named columns.

§n_rows: usize

Number of rows in the table.

§name: String

Table name

Implementations§

Source §

impl Table

Source

pub fn new(name: String, cols: Option<Vec<FieldArray>>) -> Table

Constructs a new Table with a specified name and optional columns. If cols is provided, the number of rows will be inferred from the first column.

Source

pub fn new_empty() -> Table

Constructs a new, empty Table with a globally unique name.

Source

pub fn add_col(&mut self, field_array: FieldArray)

Adds a column with a name.

Source

pub fn schema(&self) -> Vec<Arc<Field>>

Builds a schema via the underlying field arrays

Source

pub fn n_cols(&self) -> usize

Returns the number of columns.

Source

pub fn n_rows(&self) -> usize

Returns the number of rows.

Source

pub fn is_empty(&self) -> bool

Returns true if the table is empty (no columns or no rows).

Source

pub fn col_names(&self) -> Vec<&str>

Returns the list of column names.

Source

pub fn rename_columns( &mut self, mapping: &[(&str, &str)], ) -> Result<(), MinarrowError>

Rename columns in place. Each pair is (old_name, new_name).

Returns an error if any old name is not found. This is metadata-only - array data is not touched.

Source

pub fn col_name_index(&self, name: &str) -> Option<usize>

Returns the index of a column by name.

Source

pub fn col_numeric(&self, name: &str) -> Result<NumericArrayV, MinarrowError>

Resolve a named column to a NumericArrayV.

Source

pub fn col_text(&self, name: &str) -> Result<TextArrayV, MinarrowError>

Resolve a named column to a TextArrayV.

Source

pub fn col_bitmask(&self, name: &str) -> Result<BitmaskV, MinarrowError>

Resolve a named column to a BitmaskV.

Source

pub fn remove_col(&mut self, name: &str) -> bool

Removes a column by name.

Source

pub fn remove_col_at(&mut self, idx: usize) -> bool

Removes a column by index.

Source

pub fn clear(&mut self)

Clears all columns and resets row count.

Source

pub fn has_col(&self, name: &str) -> bool

Checks if a column with the given name exists.

Source

pub fn cols(&self) -> &[FieldArray]

Returns all columns as a slice.

Source

pub fn cols_mut(&mut self) -> &mut [FieldArray]

Returns mutable reference to all columns.

Source

pub fn slice_clone(&self, offset: usize, len: usize) -> Table

Returns a new owned Table containing rows [offset, offset+len).

All columns are deeply copied, but only for the affected row(s).

Source

pub fn slice(&self, offset: usize, len: usize) -> TableV

Returns a zero-copy view over rows [offset, offset+len). This view borrows from the parent table and does not copy data.

Source

pub fn map_col<T, F>(&self, col_name: &str, func: F) -> Option<T>
where F: FnOnce(&FieldArray) -> T,

Maps a function over a single column by name, returning the result. Returns None if the column doesn’t exist.

Source

pub fn map_cols_by_name<T, F>(&self, col_names: &[&str], func: F) -> Vec<T>
where F: FnMut(&FieldArray) -> T,

Maps a function over multiple columns by name, returning a Vec of results. Warns if any requested columns are missing.

Source

pub fn map_cols_by_index<T, F>(&self, indices: &[usize], func: F) -> Vec<T>
where F: FnMut(&FieldArray) -> T,

Maps a function over multiple columns by index, returning a Vec of results. Warns if any requested indices are out of bounds.

Source

pub fn map_all_cols<T, F>(&self, func: F) -> Vec<T>
where F: FnMut(&FieldArray) -> T,

Maps a function over all columns, returning a Vec of results.

Source

pub fn apply_cols<E>( &self, f: impl FnMut(&FieldArray) -> Result<FieldArray, E>, ) -> Result<Table, E>

Apply a transformation to each column, producing a new table.

The closure receives each FieldArray and returns a transformed FieldArray. To pass a column through unchanged, clone it. The closure can dispatch on Array variant to handle numeric, text, temporal, and boolean columns differently.

Source