iter

Documentation

Index

• type Iter
  • func NewIter[T any](ctx context.Context, path string, params any, query Query[T]) *Iter[T]
  • func (it *Iter[T]) Err() error
  • func (it *Iter[T]) Item() T
  • func (it *Iter[T]) Next() bool
• type ListResponse
• type Query

Types

type Iter

type Iter[T any] struct {
	// contains filtered or unexported fields
}

Iter defines an iterator type that list methods should return. The contained type should typically be a model that's returned in the results of a list method response.

func NewIter

func NewIter[T any](ctx context.Context, path string, params any, query Query[T]) *Iter[T]

NewIter returns a new initialized iterator. This method automatically makes the first query to populate the results. List methods should use this helper method when building domain specific iterators.

func (*Iter[T]) Err

func (it *Iter[T]) Err() error

Err returns any errors that occur during iteration.

func (*Iter[T]) Item

func (it *Iter[T]) Item() T

Item returns the result that the iterator is currently pointing to.

func (*Iter[T]) Next

func (it *Iter[T]) Next() bool

Next moves the iterator to the next result.

type ListResponse

type ListResponse interface {
	// NextPage returns a URL for retrieving the next page of list results.
	NextPage() string
}

ListResponse defines an interface that list API responses must implement.

type Query

type Query[T any] func(string) (ListResponse, []T, error)

Query defines a closure that domain specific iterators must implement. The implementation should include a call to the API and should return the API response with a separate slice of the results.