Struct nebari::Roots

source · [−]

pub struct Roots<File: ManagedFile> { /* private fields */ }

Expand description

A multi-tree transactional B-Tree database.

Implementations

source

impl<File: ManagedFile> Roots<File>

source

pub fn path(&self) -> &Path

Returns the path to the database directory.

source

pub fn context(&self) -> &Context<File::Manager>

Returns the vault used to encrypt this database.

source

pub fn transactions(&self) -> &TransactionManager<File::Manager>

Returns the transaction manager for this database.

source

pub fn tree<Root: Root>(
&self,
root: TreeRoot<Root, File>
) -> Result<Tree<Root, File>, Error>

Opens a tree named name.

Errors

InvalidTreeName: The name contained an invalid character. For a full list of valid characters, see the documentation on InvalidTreeName.

source

pub fn delete_tree(
&self,
name: impl Into<Cow<'static, str>>
) -> Result<bool, Error>

Removes a tree. Returns true if a tree was deleted.

source

pub fn tree_names(&self) -> Result<Vec<String>, Error>

Returns a list of all the names of trees contained in this database.

source

pub fn transaction<R: Borrow<T>, T: AnyTreeRoot<File> + ?Sized>(
&self,
trees: &[R]
) -> Result<ExecutingTransaction<File>, Error>

Begins a transaction over trees. All trees will be exclusively accessible by the transaction. Dropping the executing transaction will roll the transaction back.

Errors

InvalidTreeName: A tree name contained an invalid character. For a full list of valid characters, see the documentation on InvalidTreeName.

Trait Implementations

source

impl<File: ManagedFile> Clone for Roots<File>

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

source

impl<File: Debug + ManagedFile> Debug for Roots<File>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<File> !RefUnwindSafe for Roots<File>

impl<File> Send for Roots<File>

impl<File> Sync for Roots<File>

impl<File> Unpin for Roots<File>

impl<File> !UnwindSafe for Roots<File>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub 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<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct nebari::Roots

Implementations

impl<File: ManagedFile> Roots<File>

pub fn path(&self) -> &Path

pub fn context(&self) -> &Context<File::Manager>

pub fn transactions(&self) -> &TransactionManager<File::Manager>

pub fn tree<Root: Root>( &self, root: TreeRoot<Root, File>) -> Result<Tree<Root, File>, Error>

pub fn delete_tree( &self, name: impl Into<Cow<'static, str>>) -> Result<bool, Error>

pub fn tree_names(&self) -> Result<Vec<String>, Error>

pub fn transaction<R: Borrow<T>, T: AnyTreeRoot<File> + ?Sized>( &self, trees: &[R]) -> Result<ExecutingTransaction<File>, Error>

Trait Implementations

impl<File: ManagedFile> Clone for Roots<File>

fn clone(&self) -> Self

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

impl<File: Debug + ManagedFile> Debug for Roots<File>

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

Auto Trait Implementations

impl<File> !RefUnwindSafe for Roots<File>

impl<File> Send for Roots<File>

impl<File> Sync for Roots<File>

impl<File> Unpin for Roots<File>

impl<File> !UnwindSafe for Roots<File>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn tree<Root: Root>(
&self,
root: TreeRoot<Root, File>
) -> Result<Tree<Root, File>, Error>

pub fn delete_tree(
&self,
name: impl Into<Cow<'static, str>>
) -> Result<bool, Error>

pub fn transaction<R: Borrow<T>, T: AnyTreeRoot<File> + ?Sized>(
&self,
trees: &[R]
) -> Result<ExecutingTransaction<File>, Error>

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,