From cc8dbc697d440ac97e73c7cfbfd33fdddc83aac8 Mon Sep 17 00:00:00 2001 From: "C. Titus Brown" Date: Sun, 18 Aug 2024 06:50:41 -0700 Subject: [PATCH] add some minimal docs (based on #2230) --- src/core/src/collection.rs | 4 ++++ src/core/src/index/linear.rs | 2 ++ 2 files changed, 6 insertions(+) diff --git a/src/core/src/collection.rs b/src/core/src/collection.rs index 980682141d..bc52b35daf 100644 --- a/src/core/src/collection.rs +++ b/src/core/src/collection.rs @@ -12,11 +12,15 @@ use crate::{Error, Result}; #[cfg(feature = "parallel")] use rayon::prelude::*; +/// a Manifest and Storage, combined. Can contain any collection of signatures. + pub struct Collection { manifest: Manifest, storage: InnerStorage, } +/// A consistent collection of signatures. Can be created using `select`. + pub struct CollectionSet { collection: Collection, } diff --git a/src/core/src/index/linear.rs b/src/core/src/index/linear.rs index 71c7aef30a..5fd0c11e1e 100644 --- a/src/core/src/index/linear.rs +++ b/src/core/src/index/linear.rs @@ -17,6 +17,8 @@ use crate::sketch::Sketch; use crate::storage::SigStore; use crate::Result; +/// Supports parallel search without a particular index. + pub struct LinearIndex { collection: CollectionSet, template: Sketch,