From 7a250201b3535e484333df630b20f2d15f69d44d Mon Sep 17 00:00:00 2001 From: davidemazzocchi Date: Tue, 11 Nov 2025 11:14:00 +0100 Subject: [PATCH] doc: update ducomentation of catalog.load_by_filter --- 01.workspace/heave/src/imp/catalog_load_by_filter.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/01.workspace/heave/src/imp/catalog_load_by_filter.rs b/01.workspace/heave/src/imp/catalog_load_by_filter.rs index 198dc2d..2be8ea9 100644 --- a/01.workspace/heave/src/imp/catalog_load_by_filter.rs +++ b/01.workspace/heave/src/imp/catalog_load_by_filter.rs @@ -19,6 +19,15 @@ impl Catalog { /// state `EntityState::Loaded`. /// - Any existing in-memory entities with matching IDs are replaced. /// - **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> { let path = path::Path::new(&self.path); self.on_items(|items| {