From 9b4aa4e9643b0a5b4a554e455eac269a2472b590 Mon Sep 17 00:00:00 2001
From: Nathan Reiner <nathan@nathanreiner.xyz>
Date: Thu, 6 Jul 2023 14:20:14 +0200
Subject: add some documentation to structs

---
 src/vector.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/vector.rs')

diff --git a/src/vector.rs b/src/vector.rs
index 56d1817..0779e07 100644
--- a/src/vector.rs
+++ b/src/vector.rs
@@ -1,6 +1,10 @@
 use std::collections::HashMap;
 use std::ops::{Deref, DerefMut};
 
+/// Represents the content of a cached file.
+/// It is stored as a HashMap, because we do not
+/// have to store the zeros. With that we save a lot
+/// of storage.
 pub struct FileVector {
     data : HashMap<u64, u64>
 }
-- 
cgit v1.2.3-70-g09d2