From ae7656ea0a459fc71fc85305ad64576b74596a66 Mon Sep 17 00:00:00 2001 From: "R. Tyler Croy" Date: Tue, 18 Dec 2018 16:14:52 -0800 Subject: [PATCH] Regenerate documentation --- docs/docs/mozzoni___spec.js | 3 +- docs/docs/mozzoni__client___spec.js | 3 +- docs/docs/mozzoni__commands___spec.js | 3 +- docs/docs/mozzoni__parser___spec.js | 3 +- docs/docs/mozzoni__store___spec.html | 13 + docs/docs/mozzoni__store___spec.js | 10 + ..._store__keyvalue___hashed_maps___spec.html | 13 + ...i__store__keyvalue___hashed_maps___spec.js | 10 + .../docs/mozzoni__store__keyvalue___spec.html | 13 + docs/docs/mozzoni__store__keyvalue___spec.js | 2017 +++++++++++++ docs/documentation_index.js | 15 + docs/entities/objects.js | 21 + docs/entities/record_types.js | 14 + docs/entities/subprograms.js | 42 + docs/index.js | 2 +- docs/source_file_index.js | 8 + docs/srcs/mozzoni-store-keyvalue.ads.html | 13 + docs/srcs/mozzoni-store-keyvalue.ads.js | 2506 +++++++++++++++++ docs/srcs/mozzoni-store.ads.html | 13 + docs/srcs/mozzoni-store.ads.js | 132 + obj/.gitignore | 1 + 21 files changed, 4850 insertions(+), 5 deletions(-) create mode 100644 docs/docs/mozzoni__store___spec.html create mode 100644 docs/docs/mozzoni__store___spec.js create mode 100644 docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.html create mode 100644 docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.js create mode 100644 docs/docs/mozzoni__store__keyvalue___spec.html create mode 100644 docs/docs/mozzoni__store__keyvalue___spec.js create mode 100644 docs/srcs/mozzoni-store-keyvalue.ads.html create mode 100644 docs/srcs/mozzoni-store-keyvalue.ads.js create mode 100644 docs/srcs/mozzoni-store.ads.html create mode 100644 docs/srcs/mozzoni-store.ads.js diff --git a/docs/docs/mozzoni___spec.js b/docs/docs/mozzoni___spec.js index c8bdd90..61cc565 100644 --- a/docs/docs/mozzoni___spec.js +++ b/docs/docs/mozzoni___spec.js @@ -828,7 +828,8 @@ GNATdoc.Documentation = { "line": 17, "column": 7, "type": { - "label": "Unbounded_String" + "label": "Unbounded_String", + "docHref": "docs/unbounded_string___spec.html#L79C9" }, "description": [ ] diff --git a/docs/docs/mozzoni__client___spec.js b/docs/docs/mozzoni__client___spec.js index 8891d2e..c1232b4 100644 --- a/docs/docs/mozzoni__client___spec.js +++ b/docs/docs/mozzoni__client___spec.js @@ -671,7 +671,8 @@ GNATdoc.Documentation = { "line": 16, "column": 7, "type": { - "label": "Unbounded_String" + "label": "Unbounded_String", + "docHref": "docs/unbounded_string___spec.html#L79C9" }, "description": [ ] diff --git a/docs/docs/mozzoni__commands___spec.js b/docs/docs/mozzoni__commands___spec.js index f5875ab..46ccd26 100644 --- a/docs/docs/mozzoni__commands___spec.js +++ b/docs/docs/mozzoni__commands___spec.js @@ -518,7 +518,8 @@ GNATdoc.Documentation = { "line": 11, "column": 31, "type": { - "label": "Unbounded_String" + "label": "Unbounded_String", + "docHref": "docs/unbounded_string___spec.html#L79C9" }, "description": [ ] diff --git a/docs/docs/mozzoni__parser___spec.js b/docs/docs/mozzoni__parser___spec.js index a74b2be..676742d 100644 --- a/docs/docs/mozzoni__parser___spec.js +++ b/docs/docs/mozzoni__parser___spec.js @@ -123,7 +123,8 @@ GNATdoc.Documentation = { "line": 51, "column": 43, "type": { - "label": "Unbounded_String" + "label": "Unbounded_String", + "docHref": "docs/unbounded_string___spec.html#L79C9" }, "description": [ ] diff --git a/docs/docs/mozzoni__store___spec.html b/docs/docs/mozzoni__store___spec.html new file mode 100644 index 0000000..5df2e83 --- /dev/null +++ b/docs/docs/mozzoni__store___spec.html @@ -0,0 +1,13 @@ + + + + + + + + + +
+
+ + \ No newline at end of file diff --git a/docs/docs/mozzoni__store___spec.js b/docs/docs/mozzoni__store___spec.js new file mode 100644 index 0000000..44a4bac --- /dev/null +++ b/docs/docs/mozzoni__store___spec.js @@ -0,0 +1,10 @@ +GNATdoc.Documentation = { + "label": "Mozzoni.Store", + "qualifier": "", + "summary": [ + ], + "description": [ + ], + "entities": [ + ] +}; \ No newline at end of file diff --git a/docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.html b/docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.html new file mode 100644 index 0000000..1cd1406 --- /dev/null +++ b/docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.html @@ -0,0 +1,13 @@ + + + + + + + + + +
+
+ + \ No newline at end of file diff --git a/docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.js b/docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.js new file mode 100644 index 0000000..693452b --- /dev/null +++ b/docs/docs/mozzoni__store__keyvalue___hashed_maps___spec.js @@ -0,0 +1,10 @@ +GNATdoc.Documentation = { + "label": "Mozzoni.Store.KeyValue.Hashed_Maps", + "qualifier": "(generic instantiation)", + "summary": [ + ], + "description": [ + ], + "entities": [ + ] +}; \ No newline at end of file diff --git a/docs/docs/mozzoni__store__keyvalue___spec.html b/docs/docs/mozzoni__store__keyvalue___spec.html new file mode 100644 index 0000000..1810fdc --- /dev/null +++ b/docs/docs/mozzoni__store__keyvalue___spec.html @@ -0,0 +1,13 @@ + + + + + + + + + +
+
+ + \ No newline at end of file diff --git a/docs/docs/mozzoni__store__keyvalue___spec.js b/docs/docs/mozzoni__store__keyvalue___spec.js new file mode 100644 index 0000000..4a9b135 --- /dev/null +++ b/docs/docs/mozzoni__store__keyvalue___spec.js @@ -0,0 +1,2017 @@ +GNATdoc.Documentation = { + "label": "Mozzoni.Store.KeyValue", + "qualifier": "", + "summary": [ + ], + "description": [ + ], + "entities": [ + { + "entities": [ + { + "label": "No_Expiry", + "qualifier": "", + "line": 15, + "column": 4, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 15, + "children": [ + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Expiry" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "constant" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar.Time" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":=" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar.Time_Of" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "number", + "text": "1970" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "number", + "text": "1" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "number", + "text": "1" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "Constant to denote that there is no expiration for a Value_Type\n" + } + ] + } + ] + }, + { + "label": "No_Value", + "qualifier": "", + "line": 33, + "column": 4, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 33, + "children": [ + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Value" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "constant" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":=" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Buffer" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Null_Unbounded_String" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 34, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Expiration" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Expiry" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "-\n" + }, + { + "kind": "span", + "text": "No_Value is a sentinel value used to indicate that the given key\n" + }, + { + "kind": "span", + "text": "does not exist in the store\n" + } + ] + } + ] + }, + { + "label": "Store", + "qualifier": "", + "line": 91, + "column": 4, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 91, + "children": [ + { + "kind": "span", + "cssClass": "identifier", + "text": "Store" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Hashed_Maps.Map" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + } + ] + } + ], + "label": "Constants and variables" + }, + { + "entities": [ + { + "label": "Key_Type", + "qualifier": "", + "line": 18, + "column": 12, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 18, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "subtype" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Unbounded_String" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "Type for describing the keys for the key/value store\n" + } + ] + } + ] + }, + { + "label": "Value_Type", + "qualifier": "", + "line": 25, + "column": 9, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 25, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "record" + } + ] + }, + { + "kind": "line", + "number": 26, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Buffer", + "href": "docs/mozzoni__store__keyvalue___spec.html#L26C7" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Unbounded_String" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 27, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Expiration", + "href": "docs/mozzoni__store__keyvalue___spec.html#L27C7" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar.Time" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":=" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Expiry" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 28, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "end" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "record" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "Value_Type contains the necessary metadata for the storing and expiring\n" + }, + { + "kind": "span", + "text": "values in the key/value store\n" + } + ] + } + ], + "fields": [ + { + "label": "Buffer", + "line": 26, + "column": 7, + "type": { + "label": "Unbounded_String", + "docHref": "docs/unbounded_string___spec.html#L79C9" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "The raw unparsed value to store/retrieve.\n" + } + ] + } + ] + }, + { + "label": "Expiration", + "line": 27, + "column": 7, + "type": { + "label": "Time" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "Time (UTC) when the record should be expunged from the store\n" + } + ] + } + ] + } + ] + } + ], + "label": "Record types" + }, + { + "entities": [ + { + "label": "Exists", + "qualifier": "", + "line": 44, + "column": 13, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 44, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Exists", + "href": "docs/mozzoni__store__keyvalue___spec.html#L44C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L44C21" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + } + ] + }, + { + "kind": "line", + "number": 45, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "Checks whether the given key exists in the key/value store\n" + } + ] + } + ], + "parameters": [ + { + "label": "Key", + "line": 44, + "column": 21, + "type": { + "label": "Mozzoni.Store.KeyValue.Key_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + "description": [ + ] + } + ] + }, + { + "label": "Flush", + "qualifier": "", + "line": 83, + "column": 14, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 83, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "procedure" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Flush", + "href": "docs/mozzoni__store__keyvalue___spec.html#L83C14" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "-\n" + }, + { + "kind": "span", + "text": "Flush is a *VERY DANGEROUS* subprogram to invoke and will flush all keys\n" + }, + { + "kind": "span", + "text": "and values *IMMEDIATELY* from the store\n" + }, + { + "kind": "span", + "text": "-\n" + } + ] + } + ] + }, + { + "label": "Get", + "qualifier": "", + "line": 76, + "column": 13, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 76, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Get", + "href": "docs/mozzoni__store__keyvalue___spec.html#L76C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L76C18" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + } + ] + }, + { + "kind": "line", + "number": 77, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "-\n" + }, + { + "kind": "span", + "text": "Get will return the Value_Type, assuming it exists and has not expired, for\n" + }, + { + "kind": "span", + "text": "the given Key.\n" + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "If there is not a corresponding value in the store, then a No_Value will be\n" + }, + { + "kind": "span", + "text": "returned\n" + } + ] + } + ], + "parameters": [ + { + "label": "Key", + "line": 76, + "column": 18, + "type": { + "label": "Mozzoni.Store.KeyValue.Key_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "the key for the value to retriev\n" + } + ] + } + ] + } + ], + "returns": { + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "The stored Value_Type if the key exists and has not expired, *or* the No_Value constant\n" + } + ] + } + ] + } + }, + { + "label": "Is_Expired", + "qualifier": "", + "line": 53, + "column": 13, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 53, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Is_Expired", + "href": "docs/mozzoni__store__keyvalue___spec.html#L53C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L53C25" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + } + ] + }, + { + "kind": "line", + "number": 54, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "-\n" + }, + { + "kind": "span", + "text": "Is_Expired determines whether the given key has expired from the store\n" + } + ] + } + ], + "parameters": [ + { + "label": "Key", + "line": 53, + "column": 25, + "type": { + "label": "Mozzoni.Store.KeyValue.Key_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "a valid Key\n" + } + ] + } + ] + } + ], + "returns": { + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "True if the key does not exist or has an Expiration which has past-\n" + } + ] + } + ] + } + }, + { + "label": "Is_Valid_Key", + "qualifier": "", + "line": 41, + "column": 13, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 41, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Is_Valid_Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L41C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L41C27" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "-\n" + }, + { + "kind": "span", + "text": "Quickly verify that the given Key is valid for storage\n" + } + ] + } + ], + "parameters": [ + { + "label": "Key", + "line": 41, + "column": 27, + "type": { + "label": "Mozzoni.Store.KeyValue.Key_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "a valid Key_Type\n" + } + ] + } + ] + } + ], + "returns": { + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "True if the Key is valid, False otherwise.\n" + } + ] + } + ] + } + }, + { + "label": "Set", + "qualifier": "", + "line": 62, + "column": 13, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 62, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Set", + "href": "docs/mozzoni__store__keyvalue___spec.html#L62C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L62C18" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 63, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value", + "href": "docs/mozzoni__store__keyvalue___spec.html#L63C18" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + } + ] + }, + { + "kind": "line", + "number": 64, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + }, + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "-\n" + }, + { + "kind": "span", + "text": "Set inserts a new value into the store\n" + } + ] + } + ], + "parameters": [ + { + "label": "Key", + "line": 62, + "column": 18, + "type": { + "label": "Mozzoni.Store.KeyValue.Key_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "the key for the new value\n" + } + ] + } + ] + }, + { + "label": "Value", + "line": 63, + "column": 18, + "type": { + "label": "Mozzoni.Store.KeyValue.Value_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "a properly formed Value_Type\n" + } + ] + } + ] + } + ], + "returns": { + "description": [ + { + "kind": "paragraph", + "children": [ + { + "kind": "span", + "text": "True if the set operation could be completed successfully--\n" + } + ] + } + ] + } + } + ], + "label": "Subprograms" + }, + { + "entities": [ + { + "label": "Hashed_Maps", + "qualifier": "(generic instantiation)", + "line": 87, + "column": 12, + "src": "srcs/mozzoni-store-keyvalue.ads.html", + "summary": [ + ], + "description": [ + { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 87, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "package" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Hashed_Maps" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "new" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Containers.Hashed_Maps" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 88, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Element_Type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 89, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Hash" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Strings.Unbounded.Hash" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 90, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Equivalent_Keys" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "string", + "text": "\"=\"" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ] + } + ] + } + ], + "label": "Generic instantiations" + } + ] +}; \ No newline at end of file diff --git a/docs/documentation_index.js b/docs/documentation_index.js index d9a8001..3da9a44 100644 --- a/docs/documentation_index.js +++ b/docs/documentation_index.js @@ -43,5 +43,20 @@ GNATdoc.DocumentationIndex = [ "label": "Mozzoni.Parser", "qualifier": "", "file": "docs/mozzoni__parser___spec.html" + }, + { + "label": "Mozzoni.Store", + "qualifier": "", + "file": "docs/mozzoni__store___spec.html" + }, + { + "label": "Mozzoni.Store.KeyValue", + "qualifier": "", + "file": "docs/mozzoni__store__keyvalue___spec.html" + }, + { + "label": "Mozzoni.Store.KeyValue.Hashed_Maps", + "qualifier": "(generic instantiation)", + "file": "docs/mozzoni__store__keyvalue___hashed_maps___spec.html" } ]; \ No newline at end of file diff --git a/docs/entities/objects.js b/docs/entities/objects.js index 96152bb..b294e6b 100644 --- a/docs/entities/objects.js +++ b/docs/entities/objects.js @@ -15,12 +15,33 @@ GNATdoc.EntitiesCategory = { "declared_qualifier": "", "srcHref": "srcs/mozzoni-client.ads.html#L47" }, + { + "label": "No_Expiry", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L15C4", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L15" + }, + { + "label": "No_Value", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L33C4", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L33" + }, { "label": "Port", "docHref": "docs/mozzoni___spec.html#L9C4", "declared": "Mozzoni", "declared_qualifier": "", "srcHref": "srcs/mozzoni.ads.html#L9" + }, + { + "label": "Store", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L91C4", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L91" } ] }; \ No newline at end of file diff --git a/docs/entities/record_types.js b/docs/entities/record_types.js index 9fa0cd4..f2e18cd 100644 --- a/docs/entities/record_types.js +++ b/docs/entities/record_types.js @@ -21,6 +21,20 @@ GNATdoc.EntitiesCategory = { "declared": "Epoll", "declared_qualifier": "", "srcHref": "srcs/epoll.ads.html#L47" + }, + { + "label": "Key_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L18C12", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L18" + }, + { + "label": "Value_Type", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L25C9", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L25" } ] }; \ No newline at end of file diff --git a/docs/entities/subprograms.js b/docs/entities/subprograms.js index 5258f30..7dbc349 100644 --- a/docs/entities/subprograms.js +++ b/docs/entities/subprograms.js @@ -29,6 +29,27 @@ GNATdoc.EntitiesCategory = { "declared_qualifier": "", "srcHref": "srcs/mozzoni.ads.html#L22" }, + { + "label": "Exists", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L44C13", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L44" + }, + { + "label": "Flush", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L83C14", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L83" + }, + { + "label": "Get", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L76C13", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L76" + }, { "label": "Handle_Get", "docHref": "docs/mozzoni__commands__keys___spec.html#L12C14", @@ -57,6 +78,20 @@ GNATdoc.EntitiesCategory = { "declared_qualifier": "", "srcHref": "srcs/mozzoni-client.ads.html#L40" }, + { + "label": "Is_Expired", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L53C13", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L53" + }, + { + "label": "Is_Valid_Key", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L41C13", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L41" + }, { "label": "Load", "docHref": "docs/mozzoni__command_loader___spec.html#L6C14", @@ -134,6 +169,13 @@ GNATdoc.EntitiesCategory = { "declared_qualifier": "", "srcHref": "srcs/mozzoni-dispatch.ads.html#L21" }, + { + "label": "Set", + "docHref": "docs/mozzoni__store__keyvalue___spec.html#L62C13", + "declared": "Mozzoni.Store.KeyValue", + "declared_qualifier": "", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html#L62" + }, { "label": "Wait", "docHref": "docs/epoll___spec.html#L70C14", diff --git a/docs/index.js b/docs/index.js index 5e0c508..c0808cb 100644 --- a/docs/index.js +++ b/docs/index.js @@ -1,4 +1,4 @@ GNATdoc.Index = { "project": "Mozzoni", - "timestamp": "2018-12-16 02:33:33" + "timestamp": "2018-12-19 00:14:39" }; \ No newline at end of file diff --git a/docs/source_file_index.js b/docs/source_file_index.js index f3aad2c..d11ba40 100644 --- a/docs/source_file_index.js +++ b/docs/source_file_index.js @@ -27,6 +27,14 @@ GNATdoc.SourceFileIndex = [ "label": "mozzoni-parser.ads", "srcHref": "srcs/mozzoni-parser.ads.html" }, + { + "label": "mozzoni-store-keyvalue.ads", + "srcHref": "srcs/mozzoni-store-keyvalue.ads.html" + }, + { + "label": "mozzoni-store.ads", + "srcHref": "srcs/mozzoni-store.ads.html" + }, { "label": "mozzoni.ads", "srcHref": "srcs/mozzoni.ads.html" diff --git a/docs/srcs/mozzoni-store-keyvalue.ads.html b/docs/srcs/mozzoni-store-keyvalue.ads.html new file mode 100644 index 0000000..dc3c3e4 --- /dev/null +++ b/docs/srcs/mozzoni-store-keyvalue.ads.html @@ -0,0 +1,13 @@ + + + + + + + + + +
+
+ + \ No newline at end of file diff --git a/docs/srcs/mozzoni-store-keyvalue.ads.js b/docs/srcs/mozzoni-store-keyvalue.ads.js new file mode 100644 index 0000000..ee50534 --- /dev/null +++ b/docs/srcs/mozzoni-store-keyvalue.ads.js @@ -0,0 +1,2506 @@ +GNATdoc.SourceFile = { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 1, + "children": [ + ] + }, + { + "kind": "line", + "number": 2, + "children": [ + ] + }, + { + "kind": "line", + "number": 3, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 4, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Strings.Unbounded.Hash" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 5, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Containers.Hashed_Maps" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "use" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Containers" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 6, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Strings.Unbounded" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "use" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Strings.Unbounded" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 7, + "children": [ + ] + }, + { + "kind": "line", + "number": 8, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 9, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "-- Mozzoni.Store.KeyValue implements a simplistic key-value store interface" + } + ] + }, + { + "kind": "line", + "number": 10, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "-- with automatic expiration of items based on time or memory pressure" + } + ] + }, + { + "kind": "line", + "number": 11, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 12, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "package" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Mozzoni.Store.KeyValue", + "href": "docs/mozzoni__store__keyvalue___spec.html#L12C23" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + } + ] + }, + { + "kind": "line", + "number": 13, + "children": [ + ] + }, + { + "kind": "line", + "number": 14, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Constant to denote that there is no expiration for a Value_Type" + } + ] + }, + { + "kind": "line", + "number": 15, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Expiry", + "href": "docs/mozzoni__store__keyvalue___spec.html#L15C4" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "constant" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar.Time" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":=" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar.Time_Of" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "number", + "text": "1970" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "number", + "text": "1" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "number", + "text": "1" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 16, + "children": [ + ] + }, + { + "kind": "line", + "number": 17, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Type for describing the keys for the key/value store" + } + ] + }, + { + "kind": "line", + "number": 18, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "subtype" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Unbounded_String" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 19, + "children": [ + ] + }, + { + "kind": "line", + "number": 20, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Value_Type contains the necessary metadata for the storing and expiring" + } + ] + }, + { + "kind": "line", + "number": 21, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- values in the key/value store" + } + ] + }, + { + "kind": "line", + "number": 22, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "--" + } + ] + }, + { + "kind": "line", + "number": 23, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @field Buffer The raw unparsed value to store/retrieve." + } + ] + }, + { + "kind": "line", + "number": 24, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @field Expiration Time (UTC) when the record should be expunged from the store" + } + ] + }, + { + "kind": "line", + "number": 25, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "record" + } + ] + }, + { + "kind": "line", + "number": 26, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Buffer", + "href": "docs/mozzoni__store__keyvalue___spec.html#L26C7" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Unbounded_String" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 27, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Expiration", + "href": "docs/mozzoni__store__keyvalue___spec.html#L27C7" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Calendar.Time" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":=" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Expiry" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 28, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "end" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "record" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + } + ] + }, + { + "kind": "line", + "number": 29, + "children": [ + ] + }, + { + "kind": "line", + "number": 30, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 31, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- No_Value is a sentinel value used to indicate that the given key" + } + ] + }, + { + "kind": "line", + "number": 32, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- does not exist in the store" + } + ] + }, + { + "kind": "line", + "number": 33, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Value", + "href": "docs/mozzoni__store__keyvalue___spec.html#L33C4" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "constant" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":=" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Buffer" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Null_Unbounded_String" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 34, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Expiration" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "No_Expiry" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 35, + "children": [ + ] + }, + { + "kind": "line", + "number": 36, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 37, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Quickly verify that the given Key is valid for storage" + } + ] + }, + { + "kind": "line", + "number": 38, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "--" + } + ] + }, + { + "kind": "line", + "number": 39, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @param Key a valid Key_Type" + } + ] + }, + { + "kind": "line", + "number": 40, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @return True if the Key is valid, False otherwise." + } + ] + }, + { + "kind": "line", + "number": 41, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Is_Valid_Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L41C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L41C27" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 42, + "children": [ + ] + }, + { + "kind": "line", + "number": 43, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Checks whether the given key exists in the key/value store" + } + ] + }, + { + "kind": "line", + "number": 44, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Exists", + "href": "docs/mozzoni__store__keyvalue___spec.html#L44C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L44C21" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + } + ] + }, + { + "kind": "line", + "number": 45, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 46, + "children": [ + ] + }, + { + "kind": "line", + "number": 47, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 48, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Is_Expired determines whether the given key has expired from the store" + } + ] + }, + { + "kind": "line", + "number": 49, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "--" + } + ] + }, + { + "kind": "line", + "number": 50, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @param Key a valid Key" + } + ] + }, + { + "kind": "line", + "number": 51, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @return True if the key does not exist or has an Expiration which has past" + } + ] + }, + { + "kind": "line", + "number": 52, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 53, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Is_Expired", + "href": "docs/mozzoni__store__keyvalue___spec.html#L53C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L53C25" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + } + ] + }, + { + "kind": "line", + "number": 54, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 55, + "children": [ + ] + }, + { + "kind": "line", + "number": 56, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 57, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Set inserts a new value into the store" + } + ] + }, + { + "kind": "line", + "number": 58, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @param Key the key for the new value" + } + ] + }, + { + "kind": "line", + "number": 59, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @param Value a properly formed Value_Type" + } + ] + }, + { + "kind": "line", + "number": 60, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @return True if the set operation could be completed successfully" + } + ] + }, + { + "kind": "line", + "number": 61, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "----" + } + ] + }, + { + "kind": "line", + "number": 62, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Set", + "href": "docs/mozzoni__store__keyvalue___spec.html#L62C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L62C18" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 63, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value", + "href": "docs/mozzoni__store__keyvalue___spec.html#L63C18" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Boolean" + } + ] + }, + { + "kind": "line", + "number": 64, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 65, + "children": [ + ] + }, + { + "kind": "line", + "number": 66, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 67, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Get will return the Value_Type, assuming it exists and has not expired, for" + } + ] + }, + { + "kind": "line", + "number": 68, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- the given Key." + } + ] + }, + { + "kind": "line", + "number": 69, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "--" + } + ] + }, + { + "kind": "line", + "number": 70, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- If there is not a corresponding value in the store, then a No_Value will be" + } + ] + }, + { + "kind": "line", + "number": 71, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- returned" + } + ] + }, + { + "kind": "line", + "number": 72, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "--" + } + ] + }, + { + "kind": "line", + "number": 73, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @param Key the key for the value to retriev" + } + ] + }, + { + "kind": "line", + "number": 74, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- @return The stored Value_Type if the key exists and has not expired, *or*" + } + ] + }, + { + "kind": "line", + "number": 75, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- the No_Value constant" + } + ] + }, + { + "kind": "line", + "number": 76, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "function" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Get", + "href": "docs/mozzoni__store__keyvalue___spec.html#L76C13" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key", + "href": "docs/mozzoni__store__keyvalue___spec.html#L76C18" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "in" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "return" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + } + ] + }, + { + "kind": "line", + "number": 77, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "with" + }, + { + "kind": "span", + "cssClass": "text", + "text": " Pre => Is_Valid_Key (Key)" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 78, + "children": [ + ] + }, + { + "kind": "line", + "number": 79, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 80, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- Flush is a *VERY DANGEROUS* subprogram to invoke and will flush all keys" + } + ] + }, + { + "kind": "line", + "number": 81, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "-- and values *IMMEDIATELY* from the store" + } + ] + }, + { + "kind": "line", + "number": 82, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 83, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "procedure" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Flush", + "href": "docs/mozzoni__store__keyvalue___spec.html#L83C14" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 84, + "children": [ + ] + }, + { + "kind": "line", + "number": 85, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "private" + } + ] + }, + { + "kind": "line", + "number": 86, + "children": [ + ] + }, + { + "kind": "line", + "number": 87, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "package" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Hashed_Maps" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "new" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Containers.Hashed_Maps" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "(" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Key_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L18C12" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 88, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Element_Type" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Value_Type", + "href": "docs/mozzoni__store__keyvalue___spec.html#L25C9" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 89, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Hash" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Ada.Strings.Unbounded.Hash" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "," + } + ] + }, + { + "kind": "line", + "number": 90, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Equivalent_Keys" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "=>" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "string", + "text": "\"=\"" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ")" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 91, + "children": [ + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Store", + "href": "docs/mozzoni__store__keyvalue___spec.html#L91C4" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ":" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Hashed_Maps.Map" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + }, + { + "kind": "line", + "number": 92, + "children": [ + ] + }, + { + "kind": "line", + "number": 93, + "children": [ + ] + }, + { + "kind": "line", + "number": 94, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "end" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Mozzoni.Store.KeyValue" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ], + "label": "mozzoni-store-keyvalue.ads" +}; \ No newline at end of file diff --git a/docs/srcs/mozzoni-store.ads.html b/docs/srcs/mozzoni-store.ads.html new file mode 100644 index 0000000..f181694 --- /dev/null +++ b/docs/srcs/mozzoni-store.ads.html @@ -0,0 +1,13 @@ + + + + + + + + + +
+
+ + \ No newline at end of file diff --git a/docs/srcs/mozzoni-store.ads.js b/docs/srcs/mozzoni-store.ads.js new file mode 100644 index 0000000..8cb451a --- /dev/null +++ b/docs/srcs/mozzoni-store.ads.js @@ -0,0 +1,132 @@ +GNATdoc.SourceFile = { + "kind": "code", + "children": [ + { + "kind": "line", + "number": 1, + "children": [ + ] + }, + { + "kind": "line", + "number": 2, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 3, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "-- Mozzoni.Store is responsible for storing and managing data of various types" + } + ] + }, + { + "kind": "line", + "number": 4, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "-- for Mozzoni." + } + ] + }, + { + "kind": "line", + "number": 5, + "children": [ + { + "kind": "span", + "cssClass": "comment", + "text": "---" + } + ] + }, + { + "kind": "line", + "number": 6, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "package" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Mozzoni.Store", + "href": "docs/mozzoni__store___spec.html#L6C17" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "keyword", + "text": "is" + } + ] + }, + { + "kind": "line", + "number": 7, + "children": [ + ] + }, + { + "kind": "line", + "number": 8, + "children": [ + ] + }, + { + "kind": "line", + "number": 9, + "children": [ + ] + }, + { + "kind": "line", + "number": 10, + "children": [ + { + "kind": "span", + "cssClass": "keyword", + "text": "end" + }, + { + "kind": "span", + "cssClass": "text", + "text": " " + }, + { + "kind": "span", + "cssClass": "identifier", + "text": "Mozzoni.Store" + }, + { + "kind": "span", + "cssClass": "identifier", + "text": ";" + } + ] + } + ], + "label": "mozzoni-store.ads" +}; \ No newline at end of file diff --git a/obj/.gitignore b/obj/.gitignore index 329d455..622a94e 100644 --- a/obj/.gitignore +++ b/obj/.gitignore @@ -13,3 +13,4 @@ b__main.* interop.d gnattest/harness/ gnattest/tests/*.ads +gnatdoc/