b_tree

Struct BTreeLock

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

A futures-aware read-write lock on a BTree

Implementations§

Source§

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

Source

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

Borrow the Collator used by this B+Tree.

Source

pub fn schema(&self) -> &S

Borrow the schema of the source B+Tree.

Source§

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,

Source

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

Create a new BTreeLock in dir with the given collator.

Source

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

Load a BTreeLock with the given schema and collator from dir.

Source

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

Write any modified blocks of thie BTree to the filesystem.

Source§

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

Source

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

Lock this B+Tree for reading, without borrowing.

Source

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

Lock this B+Tree for reading.

Source

pub fn try_read(&self) -> Result<BTreeReadGuard<S, C, FE>, Error>

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

Source

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

Lock this B+Tree for writing, without borrowing.

Source

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

Lock this B+Tree for writing.

Source

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

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

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

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

§

impl<S, C, FE> !RefUnwindSafe for BTreeLock<S, C, FE>

§

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

§

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

§

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

§

impl<S, C, FE> !UnwindSafe for BTreeLock<S, C, FE>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<F, T> CastFrom<F> for T
where T: From<F>,

Source§

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.
Source§

impl<T, F> CastInto<F> for T
where F: CastFrom<T>,

Source§

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> Match for F

Source§

fn matches<T>(&self) -> bool
where T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<F, T> TryCastFrom<F> for T
where T: CastFrom<F>,

Source§

fn can_cast_from(_: &F) -> bool

Test if value can be cast into Self.
Source§

fn opt_cast_from(f: F) -> Option<T>

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

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.
Source§

impl<F, T> TryCastInto<T> for F
where T: TryCastFrom<F>,

Source§

fn can_cast_into(&self) -> bool

Test if self can be cast into T.
Source§

fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.
Source§

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err>
where OnErr: FnOnce(&Self) -> Err,

Returns Ok(T) if self can be cast into T, otherwise calls on_err.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.