Alice_Database_DBMS::json_engine

Struct JSONEngine

Source
pub struct JSONEngine { /* private fields */ }
Expand description

A struct to manage multiple collections of documents.

Implementations§

Source§

impl JSONEngine

Source

pub fn new(root: &Path) -> Self

Create a new JSONEngine.

§Parameters
  • root: The path to the root directory for data storage.
§Returns

A new instance of JSONEngine.

Source

pub fn get_collection_mut(&mut self, name: &str) -> Option<&mut Collection>

Retrieve a mutable reference to a collection by its name.

§Parameters
  • name: The name of the collection to retrieve.
§Returns

An Option containing a mutable reference to the Collection, if found.

Source

pub fn add_collection(&mut self, name: &str) -> Option<&mut Collection>

Add a new collection.

§Parameters
  • name: The name of the collection to create.
§Returns

An Option containing a mutable reference to the newly added Collection.

Source

pub fn get_collection(&self, name: &str) -> Option<&Collection>

Get a collection by name.

§Parameters
  • name: The name of the collection to retrieve.
§Returns

An Option containing a reference to the Collection, if found.

Source

pub fn get_document( &self, collection_name: &str, document_name: &str, ) -> Option<&Document>

Get a document from a specific collection.

§Parameters
  • collection_name: The name of the collection the document belongs to.
  • document_name: The name of the document to retrieve.
§Returns

An Option containing a reference to the Document, if found.

Source§

impl JSONEngine

Source

pub fn get_document_mut( &mut self, collection_name: &str, document_name: &str, ) -> Option<&mut Document>

Trait Implementations§

Source§

impl Clone for JSONEngine

Source§

fn clone(&self) -> JSONEngine

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 Debug for JSONEngine

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<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<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.