iterator

README

iterator

Install

You can install the package as below:

go get github.com/gozeloglu/iterator

Usage

Firstly, you need to create an iter object with New function. You can pass elements to that function.

it := iterator.New(1,2,3,4)

Then, you can call the methods by using it object.

package main

import "github.com/gozeloglu/iterator"

func main() {
	it := iterator.New(1,2,3,4)
	it.Next()   // Check whether there is element in next
	it.Value()  // Retrieve next element if exists
	it.Prev()   // Check whether there is element in prev
	it.ToSlice()    // Retrieve all elements in slice
	it.First()  // Updates the cursor by moving first index
	it.Last()   // Updates the cursor by moving last index
}

Running tests

You can run the test with following command.

go test
go test -v  # verbose output

You can also get code coverage with the following command.

go test -cover
go test -cover -v # verbose output

LICENSE

MIT

Documentation

Index

• type Iter
  • func New(a ...any) *Iter
  • func (i *Iter) First()
  • func (i *Iter) Last()
  • func (i *Iter) Next() bool
  • func (i *Iter) Prev() bool
  • func (i *Iter) ToSlice() []any
  • func (i *Iter) Value() any

Types

type Iter

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

Iter keeps data and index.

func New

func New(a ...any) *Iter

New creates *Iter object by given elements in parameter. If nothing is passed it creates an empty slice.

func (*Iter) First

func (i *Iter) First()

First updates the cursor by moving to first index.

func (*Iter) Last

func (i *Iter) Last()

Last updates the cursor by moving to last index. If array is empty, the cursor will be zero.

func (*Iter) Next

func (i *Iter) Next() bool

Next returns whether iter has element in next. If there is no next element, it returns false.

func (*Iter) Prev

func (i *Iter) Prev() bool

Prev returns whether iter has element in prev. If there is no previous element, it returns false.

func (*Iter) ToSlice

func (i *Iter) ToSlice() []any

ToSlice returns data.

func (*Iter) Value

func (i *Iter) Value() any

Value returns current value. If there is no value, it returns nil.