aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTucker Evans <tucker@tuckerevans.com>2020-07-08 11:21:55 -0400
committerTucker Evans <tucker@tuckerevans.com>2020-07-08 11:21:55 -0400
commit7ef7147d743b1ca1edb6d40b820c79b7527ab941 (patch)
treeed1ac92951450d33542fca5069c2438faa41a8b8
parentf9c6035f032b00584708efeffda40a6ceec8a383 (diff)
Add note on NULL keys
-rw-r--r--collections/map/map.adoc3
1 files changed, 3 insertions, 0 deletions
diff --git a/collections/map/map.adoc b/collections/map/map.adoc
index 27278b8..695f763 100644
--- a/collections/map/map.adoc
+++ b/collections/map/map.adoc
@@ -9,6 +9,9 @@ NOTE: Keys are passed as void pointers and their data is not copied (this
should be handled by the user), they should not be freed without clearing the
map.
+NOTE: NULL keys are used to distingish a empty map, therefore NULL keys should
+never be used.
+
NOTE: There is currently no way to distinquish between a failed retrieval
(pop, index, back, etc.) and returning a NULL value. Keep this in mind if
you plan on storing NULL values in the vector, there are plans to fix this in