Struct b_tree::BTreeLock

pub struct BTreeLock<S, C, FE> { /* private fields */ }

A futures-aware read-write lock on a BTree

Implementations

impl<S, C, FE> BTreeLock<S, C, FE>

pub fn collator(&self) -> &Arc<Collator<C>>

Borrow the Collator used by this B+Tree.

pub fn schema(&self) -> &S

Borrow the schema of the source B+Tree.

impl<S, C, FE> BTreeLock<S, C, FE>where S: Schema, FE: AsType<Node<Vec<Key<S::Value>>>> + Send + Sync, Node<Vec<Key<S::Value>>>: FileLoad,

pub fn create(schema: S, collator: C, dir: DirLock<FE>) -> Result<Self, Error>

Create a new BTreeLock in dir with the given collator

pub fn load(schema: S, collator: C, dir: DirLock<FE>) -> Result<Self, Error>

Load a BTreeLock with the given schema and collator from dir

impl<S, C, FE> BTreeLock<S, C, FE>where FE: Send + Sync,

pub async fn into_read(self) -> BTreeReadGuard<S, C, FE>

Lock this B+Tree for reading, without borrowing

pub async fn read(&self) -> BTreeReadGuard<S, C, FE>

Lock this B+Tree for reading

pub async fn into_write(self) -> BTreeWriteGuard<S, C, FE>

Lock this B+Tree for writing, without borrowing

pub async fn write(&self) -> BTreeWriteGuard<S, C, FE>

Lock this B+Tree for writing

Trait Implementations

impl<S, C, FE> Clone for BTreeLock<S, C, FE>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.