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

doc: update documentation of catalog.init

Browse Source
This commit is contained in:
davidemazzocchi
2025-11-11 11:02:24 +01:00
parent dcffe956fd
commit 6a8351b4d6
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
01.workspace/heave/src/imp/catalog_init.rs
View File

@@ -12,6 +12,11 @@ impl Catalog {
/// - **Database State:** Creates the SQLite file and required tables if they are not /// - **Database State:** Creates the SQLite file and required tables if they are not
/// present. If the file already exists, it does nothing. /// present. If the file already exists, it does nothing.
/// - **In-Memory State:** This method does not alter the in-memory entity cache. /// - **In-Memory State:** This method does not alter the in-memory entity cache.
///
/// # Errors
///
/// Returns `Err(FailedTo::InitDatabase)` if there is an issue creating the
/// database file or initializing its schema.
pub fn init(&self) -> result::Result<(), FailedTo> { pub fn init(&self) -> result::Result<(), FailedTo> {
let path = path::Path::new(&self.path); let path = path::Path::new(&self.path);
sqlite::init::db(path).map_err(|_| FailedTo::InitDatabase)?; sqlite::init::db(path).map_err(|_| FailedTo::InitDatabase)?;