From 982f8ee51a00c991ef142a88fd6bd8d8d00bf2d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kat=20March=C3=A1n?= Date: Sun, 30 Jun 2019 20:13:40 -0700 Subject: [PATCH] doc(index): document Entry --- src/index.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/index.rs b/src/index.rs index 2334851..f6e8a34 100644 --- a/src/index.rs +++ b/src/index.rs @@ -24,10 +24,15 @@ const INDEX_VERSION: &str = "5"; /// Represents a cache index entry, which points to content. #[derive(PartialEq, Debug)] pub struct Entry { + /// Key this entry is stored under. pub key: String, + /// Integrity hash for the stored data. Acts as a key into {cache}/content. pub integrity: Integrity, + /// Timestamp in unix milliseconds when this entry was written. pub time: u128, + /// Size of data associated with this entry. pub size: usize, + /// Arbitrary JSON metadata associated with this entry. pub metadata: Value, }