Trait DatabaseReader 

pub trait DatabaseReader {
    // Required methods
    fn get_id(&self, name: &[u8]) -> Option<FileId>;
    fn get(&self, id: &FileId) -> Result<Arc<File>, DatabaseError>;
    fn get_ref(&self, id: &FileId) -> Result<&File, DatabaseError>;
    fn get_by_name(&self, name: &[u8]) -> Result<Arc<File>, DatabaseError>;
    fn get_by_path(&self, path: &Path) -> Result<Arc<File>, DatabaseError>;
    fn files(&self) -> impl Iterator<Item = Arc<File>>;
    fn len(&self) -> usize;

    // Provided methods
    fn files_with_type(
        &self,
        file_type: FileType,
    ) -> impl Iterator<Item = Arc<File>> { ... }
    fn files_without_type(
        &self,
        file_type: FileType,
    ) -> impl Iterator<Item = Arc<File>> { ... }
    fn file_ids(&self) -> impl Iterator<Item = FileId> { ... }
    fn file_ids_with_type(
        &self,
        file_type: FileType,
    ) -> impl Iterator<Item = FileId> { ... }
    fn file_ids_without_type(
        &self,
        file_type: FileType,
    ) -> impl Iterator<Item = FileId> { ... }
    fn is_empty(&self) -> bool { ... }
}

A universal interface for reading data from any database implementation.

This trait provides a common API for querying file data, abstracting over whether the underlying source is the mutable Database or the read-optimized ReadDatabase. This allows for writing generic code that can operate on either.

Required Methods

fn get_id(&self, name: &[u8]) -> 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.

Errors

Returns DatabaseError::FileNotFound if no file with the given ID exists.

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

Retrieves a reference to a file using its stable FileId.

Errors

Returns DatabaseError::FileNotFound if no file with the given ID exists.

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

Retrieves a reference to a file using its logical name.

Errors

Returns DatabaseError::FileNotFound if no file with the given name exists.

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

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

Errors

Returns DatabaseError::FileNotFound if no file with the given path exists.

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

Returns an iterator over all files in the database.

The order is not guaranteed for Database, but is sorted by FileId for ReadDatabase, providing deterministic iteration.

fn len(&self) -> usize

Returns the total number of files in the database.

Provided Methods

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.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl DatabaseReader for Database<'_>

impl DatabaseReader for ReadDatabase