Add warning to Batch* API operations

See #1223 (comment) for more details. Signed-off-by: Chris Tarazi <[email protected]>
cilium · Nov 30, 2023 · bc109c3 · bc109c3
1 parent 3625965
commit bc109c3
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/map.go b/map.go
@@ -968,6 +968,10 @@ func (m *Map) guessNonExistentKey() ([]byte, error) {
 // "cursor" to subsequent calls of this function to continue the batching
 // operation in the case of chunking.
 //
+// Warning: This API is not very safe to use as the kernel implementation for
+// batching relies on the user to be aware of subtle details with regarding to
+// different map type implementations.
+//
 // ErrKeyNotExist is returned when the batch lookup has reached
 // the end of all possible results, even when partial results
 // are returned. It should be used to evaluate when lookup is "done".
@@ -984,6 +988,10 @@ func (m *Map) BatchLookup(cursor *BatchCursor, keysOut, valuesOut interface{}, o
 // "cursor" to subsequent calls of this function to continue the batching
 // operation in the case of chunking.
 //
+// Warning: This API is not very safe to use as the kernel implementation for
+// batching relies on the user to be aware of subtle details with regarding to
+// different map type implementations.
+//
 // ErrKeyNotExist is returned when the batch lookup has reached
 // the end of all possible results, even when partial results
 // are returned. It should be used to evaluate when lookup is "done".