diff --git a/database/iterator.go b/database/iterator.go index 283ed62..ed23ab5 100644 --- a/database/iterator.go +++ b/database/iterator.go @@ -17,46 +17,42 @@ package database // iterator until exhaustion. An iterator is not safe for concurrent use, but it // is safe to use multiple iterators concurrently. type Iterator interface { - // Next moves the iterator to the next key/value pair. It returns whether the - // iterator is exhausted. + // Next moves the iterator to the next key/value pair. It returns whether + // the iterator is exhausted. Next() bool // Error returns any accumulated error. Exhausting all the key/value pairs // is not considered to be an error. Error() error - // Key returns the key of the current key/value pair, or nil if done. The caller - // should not modify the contents of the returned slice, and its contents may - // change on the next call to Next. + // Key returns the key of the current key/value pair, or nil if done. Key() []byte - // Value returns the value of the current key/value pair, or nil if done. The - // caller should not modify the contents of the returned slice, and its contents - // may change on the next call to Next. + // Value returns the value of the current key/value pair, or nil if done. Value() []byte - // Release releases associated resources. Release should always succeed and can - // be called multiple times without causing error. + // Release releases associated resources. Release should always succeed and + // can be called multiple times without causing error. Release() } // Iteratee wraps the NewIterator methods of a backing data store. type Iteratee interface { - // NewIterator creates a binary-alphabetical iterator over the entire keyspace - // contained within the key-value database. + // NewIterator creates a binary-alphabetical iterator over the entire + // keyspace contained within the key-value database. NewIterator() Iterator - // NewIteratorWithStart creates a binary-alphabetical iterator over a subset of - // database content starting at a particular initial key (or after, if it does - // not exist). + // NewIteratorWithStart creates a binary-alphabetical iterator over a subset + // of database content starting at a particular initial key (or after, if it + // does not exist). NewIteratorWithStart(start []byte) Iterator - // NewIteratorWithPrefix creates a binary-alphabetical iterator over a subset - // of database content with a particular key prefix. + // NewIteratorWithPrefix creates a binary-alphabetical iterator over a + // subset of database content with a particular key prefix. NewIteratorWithPrefix(prefix []byte) Iterator - // NewIteratorWithStartAndPrefix creates a binary-alphabetical iterator over a - // subset of database content with a particular key prefix starting at a + // NewIteratorWithStartAndPrefix creates a binary-alphabetical iterator over + // a subset of database content with a particular key prefix starting at a // specified key. NewIteratorWithStartAndPrefix(start, prefix []byte) Iterator }