Enum tc_table::Table

pub enum Table<F, D, Txn> {
    Index(Index<F, D, Txn>),
    ROIndex(ReadOnly<F, D, Txn>),
    Table(TableIndex<F, D, Txn>),
    Aggregate(Box<Aggregate<F, D, Txn, Table<F, D, Txn>>>),
    IndexSlice(IndexSlice<F, D, Txn>),
    Limit(Box<Limited<F, D, Txn>>),
    Merge(Merged<F, D, Txn>),
    Selection(Box<Selection<F, D, Txn, Table<F, D, Txn>>>),
    TableSlice(TableSlice<F, D, Txn>),
}

An ordered collection of Rows which supports BTree-based indexing

Variants

Index(Index<F, D, Txn>)

ROIndex(ReadOnly<F, D, Txn>)

Table(TableIndex<F, D, Txn>)

Aggregate(Box<Aggregate<F, D, Txn, Table<F, D, Txn>>>)

IndexSlice(IndexSlice<F, D, Txn>)

Limit(Box<Limited<F, D, Txn>>)

Merge(Merged<F, D, Txn>)

Selection(Box<Selection<F, D, Txn, Table<F, D, Txn>>>)

TableSlice(TableSlice<F, D, Txn>)

Trait Implementations

impl<F: Clone, D: Clone, Txn: Clone> Clone for Table<F, D, Txn>

fn clone(&self) -> Table<F, D, Txn>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F, D, Txn> Debug for Table<F, D, Txn> where
    Self: Send + Sync, 

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

Formats the value using the given formatter.

impl<F, D, Txn> Display for Table<F, D, Txn> where
    Self: Send + Sync, 

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

Formats the value using the given formatter.

impl<F, D, Txn> From<Merged<F, D, Txn>> for Table<F, D, Txn>

fn from(merged: Merged<F, D, Txn>) -> Self

Performs the conversion.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> From<TableIndex<F, D, Txn>> for Table<F, D, Txn>

fn from(table: TableIndex<F, D, Txn>) -> Self

Performs the conversion.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> FromStream for Table<F, D, Txn> where
    F: TryFrom<D::File, Error = TCError>,
    D::FileClass: From<BTreeType>, 

type Context = Txn

The decoding context of this type, useful in situations where the stream to be decoded may be too large to hold in main memory.

fn from_stream<'life0, 'async_trait, De: Decoder>(
    txn: Txn,
    decoder: &'life0 mut De
) -> Pin<Box<dyn Future<Output = Result<Self, De::Error>> + Send + 'async_trait>> where
    De: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Parse this value using the given Decoder.

impl<'en, F: File<Node>, D: Dir, Txn: Transaction<D>> Hash<'en, D> for Table<F, D, Txn>

type Item = Vec<Value>

type Txn = Txn

fn hashable<'async_trait>(
    &'en self,
    txn: &'en Txn
) -> Pin<Box<dyn Future<Output = TCResult<TCTryStream<'en, Self::Item>>> + Send + 'async_trait>> where
    'en: 'async_trait,
    Self: 'async_trait, 

fn hash_hex<'async_trait>(
    &'en self,
    txn: &'en Self::Txn
) -> Pin<Box<dyn Future<Output = Result<String, TCError>> + 'async_trait + Send, Global>> where
    'en: 'async_trait,
    Self: Sync + 'async_trait, 

fn hash<'async_trait>(
    &'en self,
    txn: &'en Self::Txn
) -> Pin<Box<dyn Future<Output = Result<Bytes, TCError>> + 'async_trait + Send, Global>> where
    'en: 'async_trait,
    Self: Sync + 'async_trait, 

impl<F, D, Txn> Instance for Table<F, D, Txn> where
    Self: Send + Sync, 

type Class = TableType

The Class type of this instance

fn class(&self) -> Self::Class

Returns the [Class] of this instance.

impl<'en, F: File<Node>, D: Dir, Txn: Transaction<D>> IntoView<'en, D> for Table<F, D, Txn>

type Txn = Txn

type View = TableView<'en>

fn into_view<'async_trait>(
    self,
    txn: Txn
) -> Pin<Box<dyn Future<Output = TCResult<TableView<'en>>> + Send + 'async_trait>> where
    Self: 'async_trait, 

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> TableInstance<F, D, Txn> for Table<F, D, Txn> where
    Self: Send + Sync, 

type OrderBy = Self

The type of Table returned by this instance’s order_by method.

type Reverse = Self

The type of Table returned by this instance’s reversed method.

type Slice = Self

The type of Table returned by this instance’s slice method.

fn count<'async_trait>(
    self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<u64>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Return the number of rows in this Table.

fn delete<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Delete all rows in this Table.

fn delete_row<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    row: Row
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Delete the given Row from this table, if present.

fn index<'async_trait>(
    self,
    txn: Txn,
    columns: Option<Vec<Id>>
) -> Pin<Box<dyn Future<Output = TCResult<ReadOnly<F, D, Txn>>> + Send + 'async_trait>> where
    F: TryFrom<D::File, Error = TCError>,
    D::FileClass: From<BTreeType>,
    Self: 'async_trait, 

Construct and return a temporary index of the given columns.

fn key(&self) -> &[Column]

Return the schema of this Table’s key.

fn values(&self) -> &[Column]

Return the schema of this Table’s values.

fn schema(&self) -> TableSchema

Return the schema of this Table.

fn limit(self, limit: u64) -> Limited<F, D, Txn>

Limit the number of rows returned by rows.

fn order_by(self, order: Vec<Id>, reverse: bool) -> TCResult<Self::OrderBy>

Set the order returned by rows.

fn reversed(self) -> TCResult<Self::Reverse>

Reverse the order returned by rows.

fn slice(self, bounds: Bounds) -> TCResult<Table<F, D, Txn>>

Limit the returned rows to the given Bounds.

fn rows<'a, 'async_trait>(
    self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<TCTryStream<'a, Vec<Value>>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Return a stream of the rows in this Table.

fn validate_bounds(&self, bounds: &Bounds) -> TCResult<()>

Return an error if this table does not support the given Bounds.

fn validate_order(&self, order: &[Id]) -> TCResult<()>

Return an error if this table does not support ordering by the given columns.

fn update<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn: &'life1 Txn,
    value: Row
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    F: TryFrom<D::File, Error = TCError>,
    D::FileClass: From<BTreeType>,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Update the values of the columns in this Table to match the given Row.

fn update_row<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    row: Row,
    value: Row
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Update one row of this Table.

fn upsert<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    key: Vec<Value>,
    values: Vec<Value>
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Insert or update the given row.

fn group_by(
    self,
    columns: Vec<Id>
) -> TCResult<Aggregate<F, D, Txn, Self::OrderBy>>

Group this Table by the given columns.

fn select(self, columns: Vec<Id>) -> TCResult<Selection<F, D, Txn, Self>>

Limit the columns returned by rows.