Enum tc_table::Table

pub enum Table<F, D, Txn> {
    Table(TableIndex<F, D, Txn>),
    Index(Index<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

Table(TableIndex<F, D, Txn>)

Index(Index<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

Converts to this type from the input type.

impl<F, D, Txn> From<TableIndex<F, D, Txn>> for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    Txn: Transaction<D>,

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

Converts to this type from the input type.

impl<F, D, Txn> FromStream for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node, Inner = D::Inner> + TryFrom<D::Store, Error = TCError>,
    D: Dir + TryFrom<D::Store, Error = TCError>,
    Txn: Transaction<D>,
    D::Read: DirReadFile<F>,
    D::Write: DirCreateFile<F>,
    D::Store: From<D> + From<F>,

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

Parse this value using the given Decoder.

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, D, Txn> IntoView<'en, D> for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir + TryFrom<D::Store, Error = TCError>,
    Txn: Transaction<D>,

type Txn = Txn

The type of Transaction which this state supports

type View = TableView<'en>

The type of encodable view returned by into_view

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

Return a View which can be encoded with en::IntoStream.

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

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, D, Txn> TableOrder for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    Txn: Transaction<D>,
    Self: Send + Sync,

type OrderBy = Table<F, D, Txn>

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

type Reverse = Table<F, D, Txn>

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

fn order_by(self, order: 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, D, Txn> TableRead for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    Txn: Transaction<D>,
    Self: Send + Sync,

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
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,

impl<F, D, Txn> TableSlice for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    Txn: Transaction<D>,
    Self: Send + Sync,

type Slice = Table<F, D, Txn>

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

fn slice(self, bounds: Bounds) -> TCResult<Table<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, D, Txn> TableStream for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    Txn: Transaction<D>,
    Self: Send + Sync,

type Limit = Table<F, D, Txn>

type Selection = Table<F, D, Txn>

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 as TableStream>::Limit

Limit the number of rows returned by rows.

fn select(self, columns: Vec<Id>) -> TCResult<<Self as TableStream>::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
    Self: 'async_trait,
    'a: 'async_trait,

Return a stream of the rows in this Table.

impl<F, D, Txn> TableWrite for Table<F, D, Txn>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    Txn: Transaction<D>,
    Self: Send + Sync,

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

Insert or update the given row.