Struct Database

pub struct Database { /* private fields */ }

A mutable database for managing a collection of project files.

This struct acts as the primary “builder” for your file set. It is optimized for efficient additions, updates, and deletions. Once you have loaded all files and performed any initial modifications, you can create a high-performance, immutable snapshot for fast querying by calling read_only.

Implementations

impl Database

pub fn new() -> Self

Creates a new, empty Database.

pub fn add(&mut self, file: File)

Adds a file to the database, overwriting any existing file with the same name.

pub fn update(&mut self, id: FileId, new_contents: String) -> bool

Updates a file’s content in-place using its stable FileId.

This recalculates derived data like file size, line endings, and FileRevision. Returns true if a file with the given ID was found and updated.

pub fn delete(&mut self, id: FileId) -> bool

Deletes a file from the database using its stable FileId.

Returns true if a file with the given ID was found and removed.

pub fn commit(&mut self, change_log: ChangeLog) -> Result<(), DatabaseError>

Commits a ChangeLog, applying all its recorded operations to the database.

This method consumes the log and applies each Change sequentially. It will fail if other references to the ChangeLog still exist.

Errors

Returns a DatabaseError if the log cannot be consumed.

pub fn read_only(&self) -> ReadDatabase

Creates an independent, immutable snapshot of the database.

This is a potentially expensive one-time operation as it clones all file data. The resulting ReadDatabase is highly optimized for fast reads and guarantees a deterministic iteration order. The original Database is not consumed and can continue to be used.

Trait Implementations

impl DatabaseReader for Database

fn get_id(&self, name: &str) -> Option<FileId>

Retrieves a file’s stable ID using its logical name.

fn get_by_id(&self, id: &FileId) -> Result<&File, DatabaseError>

Retrieves a reference to a file using its stable FileId.

fn get_by_name(&self, name: &str) -> Result<&File, DatabaseError>

Retrieves a reference to a file using its logical name.

fn get_by_path(&self, path: &Path) -> Result<&File, DatabaseError>

Retrieves a reference to a file by its absolute filesystem path.

fn files(&self) -> impl Iterator<Item = &File>

Returns an iterator over all files in the database.

fn len(&self) -> usize

Returns the total number of files in the database.

fn get_name(&self, id: &FileId) -> Option<&str>

fn files_with_type(&self, file_type: FileType) -> impl Iterator<Item = &File>

Returns an iterator over all files of a specific FileType.

fn files_without_type(&self, file_type: FileType) -> impl Iterator<Item = &File>

Returns an iterator over all files that do not match a specific FileType.

fn file_ids(&self) -> impl Iterator<Item = FileId>

Returns an iterator over the stable IDs of all files in the database.

fn file_ids_with_type( &self, file_type: FileType, ) -> impl Iterator<Item = FileId>

Returns an iterator over the stable IDs of all files of a specific FileType.

fn file_ids_without_type( &self, file_type: FileType, ) -> impl Iterator<Item = FileId>

Returns an iterator over the stable IDs of all files that do not match a specific FileType.

fn is_empty(&self) -> bool

Returns true if the database contains no files.

impl Debug for Database

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

Formats the value using the given formatter.

impl Default for Database

fn default() -> Database

Returns the “default value” for a type.