aboutsummaryrefslogtreecommitdiff
path: root/src/index.rs
diff options
context:
space:
mode:
authorNathan Reiner <nathan@nathanreiner.xyz>2023-07-06 14:20:14 +0200
committerNathan Reiner <nathan@nathanreiner.xyz>2023-07-06 14:20:14 +0200
commit9b4aa4e9643b0a5b4a554e455eac269a2472b590 (patch)
treecdab839b50a137db2a6df480a0f75f1f1385cb41 /src/index.rs
parent8c3c8efa428200c67c1a6fa731faee55adf19678 (diff)
add some documentation to structs
Diffstat (limited to 'src/index.rs')
-rw-r--r--src/index.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/index.rs b/src/index.rs
index 8c358d3..616682d 100644
--- a/src/index.rs
+++ b/src/index.rs
@@ -12,6 +12,8 @@ use crate::text;
use crate::splitter;
use crate::vector;
+/// Represents a Index which is ether generated
+/// or read from a file.
pub struct Index {
dictionary : Dictionary,
filecache : Vec<FileCache>,