Struct tc_btree::BTreeFile

pub struct BTreeFile<F, D, T> { /* fields omitted */ }

The base type of a BTree

Implementations

impl<F: File<Node>, D: Dir, T: Transaction<D>> BTreeFile<F, D, T> where
    Self: Clone, 

pub async fn create(file: F, schema: RowSchema, txn_id: TxnId) -> TCResult<Self>

Create a new BTreeFile.

Trait Implementations

impl<F: File<Node>, D: Dir, T: Transaction<D>> BTreeInstance for BTreeFile<F, D, T> where
    Self: Clone,
    BTreeSlice<F, D, T>: 'static, 

type Slice = BTreeSlice<F, D, T>

fn collator(&self) -> &ValueCollator

Borrow this BTree’s collator.

fn schema(&self) -> &RowSchema

Borrow to this BTree’s schema.

fn slice(self, range: Range, reverse: bool) -> TCResult<Self::Slice>

Return a slice of this BTree with the given range.

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

Return true if this BTree has no Keys.

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

Return a Stream of this BTree’s Keys.

fn validate_key(&self, key: Key) -> TCResult<Key>

Return an error if the given key does not match this BTree’s schema

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

Return the number of Keys in this BTree.

impl<F: File<Node>, D: Dir, T: Transaction<D>> BTreeWrite for BTreeFile<F, D, T> where
    Self: Clone,
    BTreeSlice<F, D, T>: 'static, 

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

Delete all the Keys in this BTree.

fn insert<'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, 

Insert the given Key into this BTree.

fn try_insert_from<'life0, 'async_trait, S: Stream<Item = TCResult<Key>> + Send + Unpin>(
    &'life0 self,
    txn_id: TxnId,
    keys: S
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    S: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Insert all the keys from the given Stream into this BTree.

impl<F: Clone, D: Clone, T: Clone> Clone for BTreeFile<F, D, T>

fn clone(&self) -> BTreeFile<F, D, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: File<Node>, D: Dir, T: Transaction<D>, I: BTreeInstance + 'static> CopyFrom<D, I> for BTreeFile<F, D, T>

fn copy_from<'life0, 'async_trait>(
    source: I,
    file: F,
    txn: &'life0 T
) -> 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, D, T> Display for BTreeFile<F, D, T>

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

Formats the value using the given formatter.

impl<F, D, T> From<BTreeFile<F, D, T>> for BTree<F, D, T>

fn from(btree: BTreeFile<F, D, T>) -> Self

Performs the conversion.

impl<F, D, T> Instance for BTreeFile<F, D, T> where
    Self: Send + Sync, 

type Class = BTreeType

The Class type of this instance

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

Returns the [Class] of this instance.

impl<F: File<Node>, D: Dir, T: Transaction<D>> Persist<D> for BTreeFile<F, D, T>

type Schema = RowSchema

type Store = F

type Txn = T

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

Return the schema of this persistent state.

fn load<'life0, 'async_trait>(
    txn: &'life0 T,
    schema: RowSchema,
    file: F
) -> 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, T: Transaction<D>> Restore<D> for BTreeFile<F, D, T>

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, 

impl<F: File<Node> + Transact, D: Dir, T: Transaction<D>> Transact for BTreeFile<F, D, T>

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.