Enum tc_collection::CollectionBase

pub enum CollectionBase<Txn, FE> {
    BTree(BTreeFile<Txn, FE>),
    Table(TableFile<Txn, FE>),
    Tensor(TensorBase<Txn, FE>),
}

The base type of a mutable transactional collection of data.

Variants

BTree(BTreeFile<Txn, FE>)

Table(TableFile<Txn, FE>)

Tensor(TensorBase<Txn, FE>)

Implementations

impl<Txn, FE> CollectionBase<Txn, FE>

where Txn: Transaction<FE>, FE: AsType<BTreeNode> + ThreadSafe,

pub fn schema(&self) -> Schema

Return the Schema of this Collection

Trait Implementations

impl<T, FE> AsyncHash for CollectionBase<T, FE>

where T: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + Clone,

fn hash<'async_trait>( self, txn_id: TxnId ) -> Pin<Box<dyn Future<Output = TCResult<Output<Sha256>>> + Send + 'async_trait>>

where Self: 'async_trait,

Compute the hash of this state as of a given TxnId

impl<Txn: Clone, FE: Clone> Clone for CollectionBase<Txn, FE>

fn clone(&self) -> CollectionBase<Txn, FE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Txn, FE> CopyFrom<FE, Collection<Txn, FE>> for CollectionBase<Txn, FE>

where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + Clone, BTreeNode: FileLoad,

fn copy_from<'life0, 'async_trait>( txn: &'life0 Txn, store: Dir<FE>, instance: Collection<Txn, FE> ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Copy a new instance of Self from an existing instance.

impl<T, FE> Debug for CollectionBase<T, FE>

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

Formats the value using the given formatter.

impl<Txn, FE> From<CollectionBase<Txn, FE>> for Collection<Txn, FE>

fn from(base: CollectionBase<Txn, FE>) -> Self

Converts to this type from the input type.

impl<T, FE> FromStream for CollectionBase<T, FE>

where T: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + Clone,

type Context = T

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

where D: 'async_trait + Decoder, Self: 'async_trait, 'life0: 'async_trait,

Parse this value using the given Decoder.

impl<Txn, FE> Instance for CollectionBase<Txn, FE>

where Txn: Transaction<FE>, FE: ThreadSafe,

type Class = CollectionType

The Class type of this instance

fn class(&self) -> CollectionType

Returns the [Class] of this instance.

impl<'en, T, FE> IntoView<'en, FE> for CollectionBase<T, FE>

where T: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + Clone, Self: 'en,

type Txn = T

The type of Transaction which this state supports

type View = CollectionView<'en>

The type of encodable view returned by into_view

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

where Self: 'async_trait,

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

impl<Txn, FE> Persist<FE> for CollectionBase<Txn, FE>

where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + Clone, BTreeNode: FileLoad,

type Txn = Txn

type Schema = Schema

fn create<'async_trait>( txn_id: TxnId, schema: Schema, store: Dir<FE> ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>

where Self: 'async_trait,

Create a new instance of Self from an empty Store.

fn load<'async_trait>( txn_id: TxnId, schema: Schema, store: Dir<FE> ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>

where Self: 'async_trait,

Load a saved instance of Self from persistent storage. Should only be invoked at startup time.

fn dir(&self) -> Inner<FE>

Access the filesystem directory backing this persistent data structure.

fn load_or_create<'async_trait>( txn_id: TxnId, schema: Self::Schema, store: Dir<FE> ) -> Pin<Box<dyn Future<Output = Result<Self, TCError>> + Send + 'async_trait>>

where Self: Send + 'async_trait,

Load a saved instance of Self from persistent storage if present, or create a new one.

impl<Txn, FE> Restore<FE> for CollectionBase<Txn, FE>

where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + Clone, BTreeNode: FileLoad,

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restore this persistent state from a backup.

impl<State> Route<State> for CollectionBase<State::Txn, State::FE>

where State: StateInstance + From<Collection<State::Txn, State::FE>> + From<Tensor<State::Txn, State::FE>> + From<Tuple<Value>> + From<u64>, State::Class: From<NumberType>, State::FE: DenseCacheFile + AsType<Node> + AsType<Node>, BTree<State::Txn, State::FE>: TryCastFrom<State>, Collection<State::Txn, State::FE>: From<BTree<State::Txn, State::FE>>, Map<Value>: TryFrom<State, Error = TCError>, Number: TryCastFrom<State>, Scalar: TryCastFrom<State>, Tensor<State::Txn, State::FE>: TryCastFrom<State>, Tuple<State>: TryFrom<State, Error = TCError>, Value: TryCastFrom<State>, bool: TryCastFrom<State>,

fn route<'a>( &'a self, path: &'a [PathSegment] ) -> Option<Box<dyn Handler<'a, State> + 'a>>

impl<Txn, FE> Transact for CollectionBase<Txn, FE>

where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<BTreeNode> + AsType<TensorNode> + for<'en> FileSave<'en> + Clone,

type Commit = ()

A guard which blocks concurrent commits

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

where Self: 'async_trait, 'life0: 'async_trait,

Commit this transaction.

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Roll back this transaction.

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete any version data specific to this transaction.

impl<T, FE> TryCastFrom<Collection<T, FE>> for CollectionBase<T, FE>

fn can_cast_from(collection: &Collection<T, FE>) -> bool

Test if value can be cast into Self.

fn opt_cast_from(collection: Collection<T, FE>) -> Option<Self>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>

where OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.