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) -> &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<Vec<S::Value>>>> + Send + Sync, Node<Vec<Vec<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.

pub async fn sync(&self) -> Result<(), Error>where FE: for<'a> FileSave<'a>,

Write any modified blocks of thie BTree to the filesystem.

impl<S, C, FE> BTreeLock<S, C, FE>where C: Clone, 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 fn try_read(&self) -> Result<BTreeReadGuard<S, C, FE>, Error>

Lock this B+Tree for reading synchronously, if possible.

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.

pub fn try_write(&self) -> Result<BTreeWriteGuard<S, C, FE>, Error>

Lock this B+Tree for writing synchronously, if possible.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.