Struct Database 

pub struct Database<'a> { /* private fields */ }

Mutable database for managing project files with add/update/delete operations.

Implementations

impl<'a> Database<'a>

pub fn new(configuration: DatabaseConfiguration<'a>) -> Self

pub fn single(file: File, configuration: DatabaseConfiguration<'a>) -> Self

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

pub fn update(&mut self, id: FileId, new_contents: Cow<'static, str>) -> 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, write_to_disk: bool, ) -> Result<(), DatabaseError>

Commits a ChangeLog, applying all its recorded operations to the database and optionally writing them to the filesystem.

Arguments

• change_log: The log of changes to apply.
• write_to_disk: If true, changes for files that have a filesystem path will be written to disk in parallel.

Errors

Returns a DatabaseError if the log cannot be consumed or if any filesystem operation fails.

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<'a> Clone for Database<'a>

fn clone(&self) -> Database<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> DatabaseReader for Database<'a>

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

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

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

Retrieves a reference to a file using its stable FileId.

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

Retrieves a reference to a file using its stable FileId.

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

Retrieves a reference to a file using its logical name.

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

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

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

Returns an iterator over all files in the database.

fn len(&self) -> usize

Returns the total number of files in the database.

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

Returns an iterator over all files of a specific FileType.

fn files_without_type( &self, file_type: FileType, ) -> impl Iterator<Item = Arc<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<'a> Debug for Database<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Database<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Serialize for Database<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.