sliceiterator

Documentation

Overview

Package sliceiterator - builds an iterator from a slice to allow peaking for the next value.

Index

• type Iterator
  • func New(s *[]string) *Iterator
  • func (a *Iterator) ExistsNext() bool
  • func (a *Iterator) Index() int
  • func (a *Iterator) IsLast() bool
  • func (a *Iterator) Next() bool
  • func (a *Iterator) PeekNextValue() (string, bool)
  • func (a *Iterator) Remaining() []string
  • func (a *Iterator) Reset()
  • func (a *Iterator) Size() int
  • func (a *Iterator) Value() string

Types

type Iterator

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

Iterator - iterator data

func New

func New(s *[]string) *Iterator

New - builds a string Iterator

func (*Iterator) ExistsNext

func (a *Iterator) ExistsNext() bool

ExistsNext - tells if there is more data to be read.

func (*Iterator) Index

func (a *Iterator) Index() int

Index - return current index.

func (*Iterator) IsLast

func (a *Iterator) IsLast() bool

IsLast - Tells if the current element is the last.

func (*Iterator) Next

func (a *Iterator) Next() bool

Next - moves the index forward and returns a bool to indicate if there is another value.

func (*Iterator) PeekNextValue

func (a *Iterator) PeekNextValue() (string, bool)

PeekNextValue - Returns the next value and indicates whether or not it is valid.

func (*Iterator) Remaining

func (a *Iterator) Remaining() []string

Remaining - Get all remaining values index inclusive.

func (*Iterator) Reset

func (a *Iterator) Reset()

Reset - resets the index of the Iterator.

func (*Iterator) Size

func (a *Iterator) Size() int

Size - returns Iterator size

func (*Iterator) Value

func (a *Iterator) Value() string

Value - returns value at current index or an empty string if you are trying to read the value after having fully read the list.