aboutsummaryrefslogtreecommitdiff
path: root/bucket.go
diff options
context:
space:
mode:
authorBen Johnson <benbjohnson@yahoo.com>2015-09-21 14:14:00 -0600
committerBen Johnson <benbjohnson@yahoo.com>2015-09-21 14:14:00 -0600
commit51f99c862475898df9773747d3accd05a7ca33c1 (patch)
treea17df4ccb9f9a59f9e70405e9e270accf41f8872 /bucket.go
parentMerge pull request #427 from joyrexus/master (diff)
parentDocument undefined behavior in ForEach (diff)
downloaddedo-51f99c862475898df9773747d3accd05a7ca33c1.tar.gz
dedo-51f99c862475898df9773747d3accd05a7ca33c1.tar.xz
Merge pull request #428 from lukechampine/patch-1
Document undefined behavior in ForEach
Diffstat (limited to 'bucket.go')
-rw-r--r--bucket.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/bucket.go b/bucket.go
index 6766992..8c3edae 100644
--- a/bucket.go
+++ b/bucket.go
@@ -346,7 +346,8 @@ func (b *Bucket) NextSequence() (uint64, error) {
// ForEach executes a function for each key/value pair in a bucket.
// If the provided function returns an error then the iteration is stopped and
-// the error is returned to the caller.
+// the error is returned to the caller. The provided function must not modify
+// the bucket; this will result in undefined behavior.
func (b *Bucket) ForEach(fn func(k, v []byte) error) error {
if b.tx.db == nil {
return ErrTxClosed