iterators

Documentation

Index

• Variables
• type Iterable
• type Iterator
• type LinkedIterator
  • func NewLinkedIterator[T any](start LinkedIteratorElement[T], ...) *LinkedIterator[T]
  • func (i *LinkedIterator[T]) HasNext() bool
  • func (i *LinkedIterator[T]) Next() T
• type LinkedIteratorElement

Variables

var (
	ErrNoNextElement error = fmt.Errorf("Next() called on empty iterator")
)

Types

type Iterable

type Iterable[T any] interface {
	// Iterator returns an Iterator over the contained elements.
	// Note that the behavior is undefined if the underlying collection is modified while being iterated over.
	Iterator() Iterator[T]
}

type Iterator

type Iterator[T any] interface {

	// Next returns the next element of the iterated collection.
	// Panics if there is no next element.
	Next() T

	// HasNext returns true if there is a next element.
	HasNext() bool
}

type LinkedIterator

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

func NewLinkedIterator

func NewLinkedIterator[T any](start LinkedIteratorElement[T], isValidFunc func(LinkedIteratorElement[T]) bool) *LinkedIterator[T]

NewLinkedIterator returns a new LinkedIterator.

func (*LinkedIterator[T]) HasNext

func (i *LinkedIterator[T]) HasNext() bool

func (*LinkedIterator[T]) Next

func (i *LinkedIterator[T]) Next() T

type LinkedIteratorElement

type LinkedIteratorElement[T any] interface {
	// Next returns the next element.
	Next() LinkedIteratorElement[T]
	// Value returns the value of the element.
	Value() T
}