note on iterators
This commit is contained in:
parent
eb5113af55
commit
a77ac582a3
|
@ -105,11 +105,15 @@ type KVStore interface {
|
||||||
|
|
||||||
// Iterator over a domain of keys in ascending order. End is exclusive.
|
// Iterator over a domain of keys in ascending order. End is exclusive.
|
||||||
// Start must be less than end, or the Iterator is invalid.
|
// Start must be less than end, or the Iterator is invalid.
|
||||||
// To iterate over entire domain -> store.Iterator(nil, nil)
|
// Iterator must be closed by caller.
|
||||||
|
// To iterate over entire domain, use store.Iterator(nil, nil)
|
||||||
|
// CONTRACT: No writes may happen within a domain while an iterator exists over it.
|
||||||
Iterator(start, end []byte) Iterator
|
Iterator(start, end []byte) Iterator
|
||||||
|
|
||||||
// Iterator over a domain of keys in descending order. End is exclusive.
|
// Iterator over a domain of keys in descending order. End is exclusive.
|
||||||
// Start must be greater than end, or the Iterator is invalid.
|
// Start must be greater than end, or the Iterator is invalid.
|
||||||
|
// Iterator must be closed by caller.
|
||||||
|
// CONTRACT: No writes may happen within a domain while an iterator exists over it.
|
||||||
ReverseIterator(start, end []byte) Iterator
|
ReverseIterator(start, end []byte) Iterator
|
||||||
|
|
||||||
// TODO Not yet implemented.
|
// TODO Not yet implemented.
|
||||||
|
|
Loading…
Reference in New Issue