Enum tc_collection::Collection

pub enum Collection<Txn, FE> {
    BTree(BTree<Txn, FE>),
    Table(Table<Txn, FE>),
    Tensor(Tensor<Txn, FE>),
}

A mutable transactional collection of data.

Variants

BTree(BTree<Txn, FE>)

Table(Table<Txn, FE>)

Tensor(Tensor<Txn, FE>)

Implementations

impl<Txn, FE> Collection<Txn, FE>

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

pub fn schema(&self) -> Schema

Return the Schema of this Collection.

Trait Implementations

impl<Txn, FE> AsType<BTree<Txn, FE>> for Collection<Txn, FE>

fn as_type(&self) -> Option<&BTree<Txn, FE>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut BTree<Txn, FE>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<BTree<Txn, FE>>

Convert this instance into an instance of T if possible.

impl<Txn, FE> AsType<Table<Txn, FE>> for Collection<Txn, FE>

fn as_type(&self) -> Option<&Table<Txn, FE>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut Table<Txn, FE>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<Table<Txn, FE>>

Convert this instance into an instance of T if possible.

impl<Txn, FE> AsType<Tensor<Txn, FE>> for Collection<Txn, FE>

fn as_type(&self) -> Option<&Tensor<Txn, FE>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut Tensor<Txn, FE>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<Tensor<Txn, FE>>

Convert this instance into an instance of T if possible.

impl<Txn, FE> AsyncHash for Collection<Txn, FE>

where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + AsType<Node> + 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, FE> Clone for Collection<Txn, FE>

fn clone(&self) -> Self

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<Txn, FE> Debug for Collection<Txn, FE>

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

Formats the value using the given formatter.

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

fn from(t: BTree<Txn, FE>) -> Self

Converts to this type from the input type.

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

fn from(btree: BTreeFile<Txn, FE>) -> Self

Converts to this type from the input type.

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<Txn, FE> From<Table<Txn, FE>> for Collection<Txn, FE>

fn from(t: Table<Txn, FE>) -> Self

Converts to this type from the input type.

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

fn from(t: Tensor<Txn, FE>) -> Self

Converts to this type from the input type.

impl<T, FE> FromStream for Collection<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<T, FE> Instance for Collection<T, FE>

where T: 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, Txn, FE> IntoView<'en, FE> for Collection<Txn, FE>

where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + AsType<Node> + Clone,

type Txn = Txn

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<State> Route<State> for Collection<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>, Map<Value>: TryFrom<State, Error = TCError>, Number: TryCastFrom<State>, Tensor<State::Txn, State::FE>: TryCastFrom<State>, Tuple<State>: TryFrom<State, Error = TCError>, Scalar: TryCastFrom<State>, Value: TryCastFrom<State>, bool: TryCastFrom<State>,

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

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.

impl<Txn, FE> TryCastFrom<Collection<Txn, FE>> for BTree<Txn, FE>

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

Test if value can be cast into Self.

fn opt_cast_from(collection: Collection<Txn, 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.

impl<Txn, FE> TryCastFrom<Collection<Txn, FE>> for Table<Txn, FE>

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

Test if value can be cast into Self.

fn opt_cast_from(collection: Collection<Txn, 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.

impl<Txn, FE> TryCastFrom<Collection<Txn, FE>> for Tensor<Txn, FE>

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

Test if value can be cast into Self.

fn opt_cast_from(collection: Collection<Txn, 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.