Narra

Reference

std/array

std/array

Arrays: length, push, slices and loops over values and entries.

narra
import * as Arrays from "std/array"

The guide teaches it in chapter 2, Values and types.

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

Functions

entries

narra
export function entries<T>(items: Array<T>): Array<#[int, T]>

Effects: none.

Details: only as the source of a for ... of loop.

filled

narra
export function filled<T>(value: T, count: int): Option<Array<T>> uses alloc

Effects: alloc.

length

narra
export function length<T>(items: Array<T>): int

Effects: none.

push

narra
export function push<T>(mutable items: Array<T>, item: T) uses alloc

Effects: alloc.

truncate

narra
export function truncate<T>(mutable items: Array<T>, length: int)

Effects: none.

values

narra
export function values<T>(items: Array<T>): Array<T>

Effects: none.

Details: only as the source of a for ... of loop.

withCapacity

narra
export function withCapacity<T>(count: int): Array<T> uses alloc

Effects: alloc.

map

narra
export function map<T, U, effect E>(items: Array<T>, change: (T) => U uses E): Array<U> uses alloc, E

Effects: alloc, E.

slice

narra
export function slice<T>(items: Array<T>, start: int, finish: int): Option<Array<T>> uses alloc

Effects: alloc.

pop

narra
export function pop<T>(mutable items: Array<T>): Option<T> uses alloc

Effects: alloc.

indexOf

narra
export function indexOf<T: Equatable>(items: Array<T>, wanted: T): Option<int>

Effects: none.

contains

narra
export function contains<T: Equatable>(items: Array<T>, wanted: T): bool

Effects: none.

reverse

narra
export function reverse<T>(mutable items: Array<T>) uses alloc

Effects: alloc.

sort

narra
export function sort<T: Ordered>(mutable items: Array<T>) uses alloc

Effects: alloc.

sortBy

narra
export function sortBy<T, effect E>(mutable items: Array<T>, compare: (T, T) => Ordering uses E) uses alloc, E

Effects: alloc, E.