itkit

README

itkit

Short, dead simple and concise generic iterator interface. With a few extras similar to what python has to offer.

📦 Installation

$ go get -u github.com/0x5a17ed/itkit@latest

🤔 Usage

package main

import (
	"fmt"

	"github.com/0x5a17ed/itkit/iters/sliceit"
	"github.com/0x5a17ed/itkit/itlib"
)

func main() {
	s := []int{1, 2, 3}

	// iterating using the for keyword.
	for it := sliceit.In(s); it.Next(); {
		fmt.Println(it.Value())
	}

	// iterating using a slightly more functional approach.
	itlib.Apply(sliceit.In(s), func(v int) {
		fmt.Println(v)
	})
}

🥇 Acknowledgments

The iterator interface is desgined after the stateful iterators pattern explained in the brilliant blog post from https://ewencp.org/blog/golang-iterators/index.html. Most functions to manipulate iterators draw inspiration from different sources such as Python and github.com/samber/lo.

⚖️ License

itkit is licensed under the Apache License, Version 2.0.

☝️ Is it any good?

yes.

Documentation

Overview

Package itkit provides short, dead simple and concise type-safe generic iterator interfaces for Go. With a few extras similar to what Python has to offer.

Piece of advice

Abandon Hope All Ye Who Enter Here.

This Go Module is probably a collection of anti-patterns. It started as an experiment about what can be done with the new Go generics functionality that was introduced into go in the 1.18 version, although I personally like how this module turned out to be.

My recommendation for now would be to use it sparingly and use normal Go iteration with the for keyword where possible and only use itkit iterators where it makes sense to reduce code and complexity without sacrificing readability.

Index

• type Iterator

Types

type Iterator

type Iterator[T any] interface {
	// Next advances the iterator to the first/next item,
	// returning true if successful meaning there is an item
	// available to be fetched with Value and false otherwise.
	Next() bool

	// Value returns the current item if there is any and may
	// panic otherwise.
	//
	// Note: Use Next to ensure there is an item.
	Value() T
}

An Iterator allows consuming individual items in a stream of items.