Enum tc_btree::BTree

pub enum BTree<F, D, T> {
    File(BTreeFile<F, D, T>),
    Slice(BTreeSlice<F, D, T>),
}

A stateful, transaction-aware, ordered collection of Keys with O(log n) inserts and slicing

Variants

File(BTreeFile<F, D, T>)

Slice(BTreeSlice<F, D, T>)

Trait Implementations

impl<F, D, T> BTreeInstance for BTree<F, D, T>where
    F: File<Key = NodeId, Block = Node>,
    D: Dir,
    T: Transaction<D>,

type Slice = BTree<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>

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
    Self: 'async_trait,
    'life0: '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
    Self: 'a + 'async_trait,
    'a: '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
    Self: Sync + 'async_trait,
    'life0: 'async_trait,

Return the number of Keys in this BTree.

impl<F: File<Key = NodeId, Block = Node>, D: Dir, T: Transaction<D>> BTreeWrite for BTree<F, D, T>where
    Self: 'static,

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

Insert the given Key into this BTree.

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F, D, T> Debug for BTree<F, D, T>

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

Formats the value using the given formatter.

impl<F, D, T> Display for BTree<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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<F, D, T> FromStream for BTree<F, D, T>where
    F: File<Key = NodeId, Block = Node, Inner = D::Inner> + TryFrom<D::Store, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    D::Store: From<F>,
    Self: Send + Sync + 'static,

type Context = (T, F)

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>(
    cxt: (T, F),
    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: Send + Sync, D: Send + Sync, T: Send + Sync> Instance for BTree<F, D, T>

type Class = BTreeType

The Class type of this instance

fn class(&self) -> BTreeType

Returns the [Class] of this instance.

impl<'en, F, D, T> IntoView<'en, D> for BTree<F, D, T>where
    F: File<Key = NodeId, Block = Node> + TryFrom<D::Store, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    Self: 'static,

type Txn = T

The type of Transaction which this state supports

type View = BTreeView<'en>

The type of encodable view returned by into_view

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

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