Struct nebari::Roots

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

A multi-tree transactional B-Tree database.

Implementations

impl<File: ManagedFile> Roots<File>

pub fn path(&self) -> &Path

Returns the path to the database directory.

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

Returns the vault used to encrypt this database.

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

Returns the transaction manager for this database.

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.

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

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

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

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

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

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.