Narra

Reference

std/iterator

std/iterator

Lazy and eager operations over generators.

narra
import * as Iterators from "std/iterator"

The guide teaches it in chapter 13, The standard library.

This page is generated by scripts/std/generate.nra from narrac query --json interface std/iterator. Do not edit it.

Functions

map

narra
export function* map<T, U, effect E>(source: Generator<T> uses E, escaping transform: (T) => U uses E): Generator<U> uses E

Effects: E.

filter

narra
export function* filter<T, effect E>(source: Generator<T> uses E, escaping keep: (T) => bool uses E): Generator<T> uses E

Effects: E.

flatMap

narra
export function* flatMap<T, U, effect E>(source: Generator<T> uses E, escaping expand: (T) => Generator<U> uses E uses (E, alloc)): Generator<U> uses (E, alloc)

Effects: E, alloc.

take

narra
export function* take<T, effect E>(source: Generator<T> uses E, count: int): Generator<T> uses E

Effects: E.

drop

narra
export function* drop<T, effect E>(source: Generator<T> uses E, count: int): Generator<T> uses E

Effects: E.

takeWhile

narra
export function* takeWhile<T, effect E>(source: Generator<T> uses E, escaping keep: (T) => bool uses E): Generator<T> uses E

Effects: E.

dropWhile

narra
export function* dropWhile<T, effect E>(source: Generator<T> uses E, escaping skip: (T) => bool uses E): Generator<T> uses E

Effects: E.

enumerate

narra
export function* enumerate<T, effect E>(source: Generator<T> uses E): Generator<#[int, T]> uses E

Effects: E.

zip

narra
export function* zip<A, B, effect E>(first: Generator<A> uses E, second: Generator<B> uses E): Generator<#[A, B]> uses (E, alloc)

Effects: E, alloc.

concat

narra
export function* concat<T, effect E>(first: Generator<T> uses E, second: Generator<T> uses E): Generator<T> uses E

Effects: E.

chunk

narra
export function chunk<T, effect E>(source: Generator<T> uses E, size: int): Option<Generator<Array<T>> uses (E, alloc)> uses alloc

Effects: alloc.

window

narra
export function window<T, effect E>(source: Generator<T> uses E, size: int): Option<Generator<Array<T>> uses (E, alloc)> uses alloc

Effects: alloc.

reduce

narra
export function reduce<T, U, effect E>(source: Generator<T> uses E, combine: (U, T) => U uses E, initial: U): U from initial uses E

Effects: E.

toArray

narra
export function toArray<T, effect E>(source: Generator<T> uses E): Array<T> from source uses E, alloc

Effects: E, alloc.

forEach

narra
export function forEach<T, effect E>(source: Generator<T> uses E, visit: (T) => void uses E) uses E

Effects: E.

some

narra
export function some<T, effect E>(source: Generator<T> uses E, predicate: (T) => bool uses E): bool uses E

Effects: E.

every

narra
export function every<T, effect E>(source: Generator<T> uses E, predicate: (T) => bool uses E): bool uses E

Effects: E.

find

narra
export function find<T, effect E>(source: Generator<T> uses E, predicate: (T) => bool uses E): Option<T> from source uses E

Effects: E.

count

narra
export function count<T, effect E>(source: Generator<T> uses E): int uses E

Effects: E.