Struct tc_table::TableIndex

pub struct TableIndex<F, D, Txn> { /* fields omitted */ }

The base type of a Table.

Implementations

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

pub async fn create(
    context: &D,
    schema: TableSchema,
    txn_id: TxnId
) -> TCResult<TableIndex<F, D, Txn>> where
    D::File: AsType<F>,
    D::FileClass: From<BTreeType>, 

Create a new TableIndex with the given TableSchema.

pub async fn is_empty(&self, txn: &Txn) -> TCResult<bool>

Return true if this table has zero rows.

pub fn merge_bounds(&self, all_bounds: Vec<Bounds>) -> TCResult<Bounds>

Merge the given list of Bounds into a single Bounds instance.

Returns an error in the case that later Bounds are larger than earlier Bounds.

pub fn primary(&self) -> &Index<F, D, Txn>

Borrow the primary Index of this TableIndex.

pub fn supporting_index(&self, bounds: &Bounds) -> TCResult<Index<F, D, Txn>>

Return an index which supports the given Bounds, or an error if there is none.

pub async fn slice_rows<'a>(
    self,
    txn_id: TxnId,
    bounds: Bounds,
    reverse: bool
) -> TCResult<TCBoxTryStream<'a, Vec<Value>>>

Stream the rows within the given Bounds from the primary index of this TableIndex.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>, I: TableStream + 'static> CopyFrom<D, I> for TableIndex<F, D, Txn> where
    D::File: AsType<F>,
    <D as Dir>::FileClass: From<BTreeType> + Send, 

fn copy_from<'life0, 'async_trait>(
    source: I,
    dir: D,
    txn: &'life0 Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Copy a new instance of Self from an existing instance.

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

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

Formats the value using the given formatter.

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>> Instance for TableIndex<F, D, Txn>

type Class = TableType

The Class type of this instance

fn class(&self) -> TableType

Returns the [Class] of this instance.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> Persist<D> for TableIndex<F, D, Txn> where
    D::File: AsType<F>,
    <D as Dir>::FileClass: From<BTreeType> + Send, 

type Schema = TableSchema

type Store = D

type Txn = Txn

fn schema(&self) -> &Self::Schema

Return the schema of this persistent state.

fn load<'life0, 'async_trait>(
    txn: &'life0 Txn,
    schema: Self::Schema,
    store: Self::Store
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Load a saved state from persistent storage.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> Restore<D> for TableIndex<F, D, Txn> where
    D::File: AsType<F>,
    <D as Dir>::FileClass: From<BTreeType> + Send, 

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

Restore this persistent state from a backup.

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

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.

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

type OrderBy = Merged<F, D, Txn>

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

type Reverse = Merged<F, D, Txn>

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

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

Return an ordered view of this table.

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

Reverse the order returned by rows.

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

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

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

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

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

type Slice = Merged<F, D, Txn>

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

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

Limit the returned rows to the given Bounds.

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

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

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

type Limit = Limited<F, D, Txn>

type Selection = Selection<F, D, Txn, Self>

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 limit(self, limit: u64) -> Self::Limit

Limit the number of rows returned by rows.

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

Limit the columns returned by rows.

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

Return a stream of the rows in this Table.

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

fn delete<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    key: Key
) -> 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 update<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    key: Key,
    values: 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: Key,
    values: Values
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Insert or update the given row.

impl<F: File<Node> + Transact, D: Dir, Txn: Transaction<D>> Transact for TableIndex<F, D, Txn>

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

Commit this transaction.

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

Delete any version data specific to this transaction.