iter

Documentation

Overview

Package iter provides an interface for efficiently working with streams of data across different data structures and algorithms, enabling a more ergonomic coding.

Example

package main

import (
	"fmt"

	"github.com/theMagicalKarp/iter/pkg/iter"
)

func main() {
	items := iter.New("hello", "world", "!!!")

	for item, ok := items.Next(); ok; item, ok = items.Next() {
		fmt.Println(item)
	}
}

Output:

hello
world
!!!

Index

• type Iterable
  • func New[T any](items ...T) Iterable[T]

Examples

• Package

Types

type Iterable

type Iterable[T any] interface {
	// Next returns the next element in the collection and a boolean value indicating if the value was found.
	Next() (T, bool)
}

Iterable represents a generic iterable collection.

func New

func New[T any](items ...T) Iterable[T]

NewIter creates a new iterable from the given items. It takes a variadic parameter `items` of type `T` and returns an `Iterable` of type `T`. The `Iterable` allows iterating over the items using the `Next` method.