note on iterators

This commit is contained in:
Ethan Buchman 2018-06-16 17:45:48 -07:00
parent eb5113af55
commit a77ac582a3
1 changed files with 5 additions and 1 deletions

View File

@ -105,11 +105,15 @@ type KVStore interface {
// Iterator over a domain of keys in ascending order. End is exclusive.
// 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 over a domain of keys in descending order. End is exclusive.
// 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
// TODO Not yet implemented.