pub struct LazyDB { /* private fields */ }

Implementations§

source§

impl LazyDB

source

pub fn init(path: impl AsRef<Path>) -> Result<Self, LDBError>

Initialises a new LazyDB directory at a specified path.

It will create the path if it doesn’t already exist and initialise a metadata file with the current version of lazy-db if one doesn’t exist already.

WARNING: if you initialise the database this way, you cannot compile it in future without errors being thrown! If you want to compile it, then use LazyDB::init_db instead.

source

pub fn init_db(path: impl AsRef<Path>) -> Result<Self, LDBError>

Initialise a new compiled LazyDB (compressed tarball) at the specified path.

It will create the path if it doesn’t already exist and initialise a metadata file with the current version of lazy-db if one doesn’t exist already.

source

pub fn load_dir(path: impl AsRef<Path>) -> Result<Self, LDBError>

Loads a pre-existing LazyDB directory at a specified path.

Loads LazyDB as read-write allowing for modification of the data within it.

If the LazyDB is invalid, it will return an error.

source

pub fn load_db(path: impl AsRef<Path>) -> Result<Self, LDBError>

Loads a pre-existing LazyDB file (compressed tarball) at a specified path

Loads LazyDB as read-write allowing for modification of the data within it.

If a directory version of the LazyDatabase exists, it will load the directory version instead of decompiling.

If the LazyDB is invalid, it will return an error.

source

pub fn as_container(&self) -> Result<LazyContainer, LDBError>

Gets the ‘root’ container of the LazyDB

source

pub fn compile(&self) -> Result<PathBuf, Error>

Compiles a modifiable LazyDatabase directory into a compressed tarball (doesn’t delete the modifable directory).

source

pub fn decompile(path: impl AsRef<Path>) -> Result<PathBuf, LDBError>

Decompiles a compressed tarball LazyDatabase into a modifiable directory (doesn’t remove the compressed tarball)

Trait Implementations§

source§

impl Drop for LazyDB

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.