iterator

Documentation

Overview

Package iterator provides a generic iterator to be used as a building block for typed iterators. In your applications, use the typed iterators returned by the secrethub package.

Index

• Variables
• type Iterator
  • func New(newPaginator PaginatorConstructor) Iterator
  • func (it *Iterator) Next() (interface{}, error)
• type Paginator
• type PaginatorConstructor
  • func PaginatorFactory(fetch func() ([]interface{}, error)) PaginatorConstructor

Variables

var (
	Done = errio.Namespace("iterator").Code("done").Error("there are no more items left")
)

Errors

Types

type Iterator

type Iterator struct {
	// contains filtered or unexported fields
}

func New

func New(newPaginator PaginatorConstructor) Iterator

func (*Iterator) Next

func (it *Iterator) Next() (interface{}, error)

type Paginator

type Paginator interface {
	Next() ([]interface{}, error)
}

type PaginatorConstructor

type PaginatorConstructor func() (Paginator, error)

func PaginatorFactory

func PaginatorFactory(fetch func() ([]interface{}, error)) PaginatorConstructor

PaginatorFactory returns a paginator constructor that constructs a paginator with the provided fetch function.