Struct Table

pub struct Table<'a, S: Scalar> { /* private fields */ }

A table of data, with schema included. This is simply a map from Identifier to Column, where columns order matters. This is primarily used as an internal result that is used before converting to the final result in either Arrow format or JSON. This is the analog of an arrow RecordBatch.

Implementations

impl<'a, S: Scalar> Table<'a, S>

pub fn try_new( table: IndexMap<Identifier, Column<'a, S>, BuildHasherDefault<AHasher>>, ) -> Result<Self, TableError>

Creates a new Table with the given columns and default TableOptions.

pub fn try_new_with_options( table: IndexMap<Identifier, Column<'a, S>, BuildHasherDefault<AHasher>>, options: TableOptions, ) -> Result<Self, TableError>

Creates a new Table with the given columns and with TableOptions.

pub fn try_from_iter<T: IntoIterator<Item = (Identifier, Column<'a, S>)>>( iter: T, ) -> Result<Self, TableError>

Creates a new Table from an iterator of (Identifier, Column) pairs with default TableOptions.

pub fn try_from_iter_with_options<T: IntoIterator<Item = (Identifier, Column<'a, S>)>>( iter: T, options: TableOptions, ) -> Result<Self, TableError>

Creates a new Table from an iterator of (Identifier, Column) pairs with TableOptions.

pub fn num_columns(&self) -> usize

Number of columns in the table.

pub fn num_rows(&self) -> usize

Number of rows in the table.

pub fn is_empty(&self) -> bool

Whether the table has no columns.

pub fn into_inner( self, ) -> IndexMap<Identifier, Column<'a, S>, BuildHasherDefault<AHasher>>

Returns the columns of this table as an IndexMap

pub fn inner_table( &self, ) -> &IndexMap<Identifier, Column<'a, S>, BuildHasherDefault<AHasher>>

Returns the columns of this table as an IndexMap

pub fn schema(&self) -> Vec<ColumnField>

Return the schema of this table as a Vec of ColumnFields

pub fn column_names(&self) -> impl Iterator<Item = &Identifier>

Returns the columns of this table as an Iterator

pub fn columns(&self) -> impl Iterator<Item = &Column<'a, S>>

Returns the columns of this table as an Iterator

pub fn column(&self, index: usize) -> Option<&Column<'a, S>>

Returns the column with the given position.

Trait Implementations

impl<'a, S: Clone + Scalar> Clone for Table<'a, S>

fn clone(&self) -> Table<'a, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug + Scalar> Debug for Table<'a, S>

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

Formats the value using the given formatter.

impl<'a, S: Scalar> From<&Table<'a, S>> for OwnedTable<S>

fn from(value: &Table<'a, S>) -> Self

Converts to this type from the input type.

impl<S: Scalar> From<Table<'_, S>> for ProvableQueryResult

fn from(table: Table<'_, S>) -> Self

Converts to this type from the input type.

impl<'a, S: Scalar> From<Table<'a, S>> for OwnedTable<S>

fn from(value: Table<'a, S>) -> Self

Converts to this type from the input type.

impl<S: Scalar> PartialEq for Table<'_, S>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, S: Eq + Scalar> Eq for Table<'a, S>