From 3bc16637a0b3b468a52b23bc14e079fbfb0b8d07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89milie=20Feral?= Date: Thu, 22 Mar 2018 13:22:46 +0100 Subject: [PATCH] [ion] Storage: add comment on Record --- ion/include/ion/storage.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/ion/include/ion/storage.h b/ion/include/ion/storage.h index 63e3c265a..dd001a72d 100644 --- a/ion/include/ion/storage.h +++ b/ion/include/ion/storage.h @@ -19,6 +19,12 @@ namespace Ion { class Storage { public: class Record { + /* A Record is identified by the CRC32 on his name because: + * - a record is identified by its name which is unique + * - we cannot keep the address pointing to the name because if another + * record is modified, it might alter our record name address and keeping + * a buffer with the name will waste memory as we cannot forsee the size + * of the name. */ friend class Storage; public: enum class ErrorStatus {