Documentation
¶
Overview ¶
Package iterator describes a generic Iterator interface.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrIteratorDone = errors.New("iterator is read to the end or closed")
ErrIteratorDone is returned when the iterator is read to the end or closed.
Functions ¶
Types ¶
type Interface ¶
type Interface[K, V any] interface { // Next returns the next key/value pair, where the key is a slice index, map key, document number, etc, // and the value is the slice or map value, next document, etc. // // Returned error could be (possibly wrapped) ErrIteratorDone or some fatal error // like (possibly wrapped) context.Canceled. // In any case, even if iterator was read to the end, and Next returned ErrIteratorDone, // or Next returned fatal error, // Close method still should be called. // // Next should not be called concurrently. Next() (K, V, error) // Close indicates that the iterator will no longer be used. // After Close is called, future calls to Next must return ErrIteratorDone, // even if previous call returned a different error. // // Close must be called. // If it wasn't, the iterator might leak resources or panic later. // // Close must be concurrency-safe and may be called multiple times. // All calls after the first should have no observable effect. Close() }
Interface is an iterator interface.
Click to show internal directories.
Click to hide internal directories.