iterator

Documentation

Index

• type Iterator
  • func New() *Iterator
  • func (it *Iterator) Cancel()
  • func (it *Iterator) Err() error
  • func (it *Iterator) Finish(err error)

Types

type Iterator

type Iterator struct {
	Next chan record.Record
	Done chan struct{}
	// contains filtered or unexported fields
}

Iterator defines the iterator structure.

func New

func New() *Iterator

New creates a new Iterator.

func (*Iterator) Cancel

func (it *Iterator) Cancel()

Cancel is called by the iteration consumer to cancel the running query.

func (*Iterator) Err

func (it *Iterator) Err() error

Err returns the iterator error, if exists.

func (*Iterator) Finish

func (it *Iterator) Finish(err error)

Finish is called be the storage to signal the end of the query results.