Struct JsonDatabase

pub struct JsonDatabase<T> { /* private fields */ }

A simple JSON file-based database ORM for Rust.

Implementations

impl<T> JsonDatabase<T>

where T: Serialize + for<'de> Deserialize<'de> + Clone + Identifiable,

pub fn new(model_name: Option<&str>) -> Self

Creates a new JsonDatabase instance.

Arguments

• model_name - Optional model name to initialize the database with.

Examples

let db: JsonDatabase<User> = JsonDatabase::new(Some("users"));

pub fn model(&mut self, model_name: &str) -> &mut Self

Sets the model name for the database and ensures the directory exists.

Arguments

• model_name - The name of the model to use.

Examples

let mut db: JsonDatabase<User> = JsonDatabase::new(None);
db.model("users");

pub fn create_model(&self, data: T)

Creates a new model in the database.

Arguments

• data - The data to create.

Panics

Panics if the data does not have an ID field.

pub fn create(&self, id: &str, data: T)

Creates a new record in the database.

Arguments

• id - The ID of the record.
• data - The data to create.

pub fn find_by_id(&self, id: &str) -> Option<T>

Finds a record by ID.

Arguments

• id - The ID of the record to find.

Returns

Returns Some(T) if the record is found, or None if not.

pub fn update_by_id(&self, id: &str, data: Value)

Updates a record by ID.

Arguments

• id - The ID of the record to update.
• data - The data to update.

pub fn delete_by_id(&self, id: &str)

Deletes a record by ID.

Arguments

• id - The ID of the record to delete.

pub fn find_all(&self) -> Vec<T>

Finds all records.

Returns

Returns a vector of all records.

pub fn find(&self, condition: &Value) -> Vec<T>

Finds records matching a condition.

Arguments

• condition - The condition to match.

Returns

Returns a vector of matching records.

pub fn find_one(&self, condition: &Value) -> Option<T>

Finds the first record matching a condition.

Arguments

• condition - The condition to match.

Returns

Returns Some(T) if a matching record is found, or None if not.

pub fn count(&self, condition: &Value) -> usize

Counts the number of records matching a condition.

Arguments

• condition - The condition to match.

Returns

Returns the number of matching records.

pub fn update_many(&self, condition: &Value, data: &Value)

Updates multiple records matching a condition.

Arguments

• condition - The condition to match.
• data - The data to update.

pub fn delete_many(&self, condition: &Value)

Deletes multiple records matching a condition.

Arguments

• condition - The condition to match.

pub fn push(&self, condition: &Value, array_path: &str, element: &Value)

Adds an element to an array in records matching a condition.

Arguments

• condition - The condition to match.
• array_path - The path to the array.
• element - The element to add.

pub fn pull(&self, condition: &Value, array_path: &str, pull_condition: &Value)

Removes elements from an array in records matching a condition.

Arguments

• condition - The condition to match.
• array_path - The path to the array.
• pull_condition - The condition to match elements to remove.

pub fn update_array( &self, condition: &Value, array_path: &str, array_condition: &Value, updates: &Value, )

Updates elements in an array in records matching a condition.

Arguments

• condition - The condition to match.
• array_path - The path to the array.
• array_condition - The condition to match array elements.
• updates - The updates to apply to matching elements.

impl JsonDatabase<()>

pub fn set_base_dir(base_dir: &str)

Sets the base directory for the database.

Arguments

• base_dir - The base directory for the database.

Examples

JsonDatabase::set_base_dir("custom-dir");

Trait Implementations

impl<T: Clone> Clone for JsonDatabase<T>

fn clone(&self) -> JsonDatabase<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for JsonDatabase<T>

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

Formats the value using the given formatter.