From e4a95506d8399211a8d3d42f3640d86d3533f9ba Mon Sep 17 00:00:00 2001
From: Brian Lewis <keller@csh.rit.edu>
Date: Mon, 21 Mar 2022 15:13:29 +0100
Subject: [PATCH] Add doc comment for ingest_structure
---
freva/src/drs/ingest.rs | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/freva/src/drs/ingest.rs b/freva/src/drs/ingest.rs
index a9fcc38..3c1f270 100644
--- a/freva/src/drs/ingest.rs
+++ b/freva/src/drs/ingest.rs
@@ -100,6 +100,12 @@ pub async fn ingest<P: AsRef<Path>>(
})
}
+/// Ingests a single structure from the DRS config.
+///
+/// This handles crawling the structure's `root_dir` and ingesting any files it finds there are valid for the structure.
+/// This inserts the files it finds into both files and latest collection within solr.
+///
+/// Invalid files, whatever the reason they're invalid, will be skipped.
async fn ingest_structure(
solr: Solr,
structure: Structure,
--
GitLab