From 8a23cfc34d483476b175727d716d7cbcf1bc7cea Mon Sep 17 00:00:00 2001 From: davidemazzocchi Date: Tue, 11 Nov 2025 11:14:15 +0100 Subject: [PATCH] doc: update documentation of catalog.load_by_class --- 01.workspace/heave/src/imp/catalog_load_by_class.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/01.workspace/heave/src/imp/catalog_load_by_class.rs b/01.workspace/heave/src/imp/catalog_load_by_class.rs index 9b1d3da..9f39423 100644 --- a/01.workspace/heave/src/imp/catalog_load_by_class.rs +++ b/01.workspace/heave/src/imp/catalog_load_by_class.rs @@ -14,6 +14,15 @@ impl Catalog { /// state `EntityState::Loaded`. /// - Any existing in-memory entities with matching IDs are replaced. /// - **Database State:** Unchanged. + /// + /// # Type Parameters + /// + /// * `T` - The type of the entity to load, which must implement the `EAV` trait. + /// + /// # Errors + /// + /// Returns `Err(FailedTo::LoadFromDB)` if there is an issue loading entities + /// from the database. pub fn load_by_class(&mut self) -> Result<(), FailedTo> where T: EAV,