rusty-donkey/heave
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: update ducomentation of catalog.load_by_filter

Browse Source
This commit is contained in:
davidemazzocchi
2025-11-11 11:14:00 +01:00
parent 5a15a018ab
commit 7a250201b3
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
01.workspace/heave/src/imp/catalog_load_by_filter.rs
View File

@@ -19,6 +19,15 @@ impl Catalog {
/// state `EntityState::Loaded`. /// state `EntityState::Loaded`.
/// - Any existing in-memory entities with matching IDs are replaced. /// - Any existing in-memory entities with matching IDs are replaced.
/// - **Database State:** Unchanged. /// - **Database State:** Unchanged.
///
/// # Arguments
///
/// * `filter` - The `Filter` to apply when loading entities.
///
/// # Errors
///
/// Returns `Err(FailedTo::LoadFromDB)` if there is an issue loading entities
/// from the database based on the provided filter.
pub fn load_by_filter(&mut self, filter: &Filter) -> Result<(), FailedTo> { pub fn load_by_filter(&mut self, filter: &Filter) -> Result<(), FailedTo> {
let path = path::Path::new(&self.path); let path = path::Path::new(&self.path);
self.on_items(|items| { self.on_items(|items| {