Documentation

isEmpty : List * -> Bool

Check if the list is empty.

List.isEmpty [1, 2, 3]

List.isEmpty []

get : List a, U64 -> Result a [OutOfBounds]

Returns an element from a list at the given index.

Returns Err OutOfBounds if the given index exceeds the List's length

expect List.get [100, 200, 300] 1 == Ok 200
expect List.get [100, 200, 300] 5 == Err OutOfBounds

replace : List a, U64, a -> { list : List a, value : a }

set : List a, U64, a -> List a

Replaces the element at the given index with a replacement.

List.set ["a", "b", "c"] 1 "B"

If the given index is outside the bounds of the list, returns the original list unmodified.

To drop the element at a given index, instead of replacing it, see List.dropAt.

update : List a, U64, (a -> a) -> List a

Updates the element at the given index with the given function.

List.update [1, 2, 3] 1 (\x -> x + 1)

If the given index is outside the bounds of the list, returns the original list unmodified.

To replace the element at a given index, instead of updating based on the current value, see List.set and List.replace

append : List a, a -> List a

Add a single element to the end of a list.

List.append [1, 2, 3] 4

[0, 1, 2]
    |> List.append 3

appendIfOk : List a, Result a * -> List a

If the given Result is Ok, add it to the end of a list. Otherwise, return the list unmodified.

List.appendIfOk [1, 2, 3] (Ok 4)

[0, 1, 2]
    |> List.appendIfOk (Err 3)

prepend : List a, a -> List a

Add a single element to the beginning of a list.

List.prepend [1, 2, 3] 0

[2, 3, 4]
    |> List.prepend 1

prependIfOk : List a, Result a * -> List a

If the given Result is Ok, add it to the beginning of a list. Otherwise, return the list unmodified.

List.prepend [1, 2, 3] (Ok 0)

[2, 3, 4]
    |> List.prepend (Err 1)

len : List * -> U64

Returns the length of the list - the number of elements it contains.

One List can store up to Num.maxI64 elements on 64-bit targets and Num.maxI32 on 32-bit targets like wasm. This means the #U64 this function returns can always be safely converted to #I64 or #I32, depending on the target.

withCapacity : U64 -> List *

Create a list with space for at least capacity elements

reserve : List a, U64 -> List a

Enlarge the list for at least capacity additional elements

releaseExcessCapacity : List a -> List a

Shrink the memory footprint of a list such that it's capacity and length are equal. Note: This will also convert seamless slices to regular lists.

concat : List a, List a -> List a

Put two lists together.

List.concat [1, 2, 3] [4, 5]

[0, 1, 2]
    |> List.concat [3, 4]

last : List a -> Result a [ListWasEmpty]

Returns the last element in the list, or ListWasEmpty if it was empty.

expect List.last [1, 2, 3] == Ok 3
expect List.last [] == Err ListWasEmpty

single : a -> List a

A list with a single element in it.

This is useful in pipelines, like so:

websites =
    Str.concat domain ".com"
        |> List.single

repeat : a, U64 -> List a

Returns a list with the given length, where every element is the given value.

reverse : List a -> List a

Returns the list with its elements reversed.

expect List.reverse [1, 2, 3] == [3, 2, 1]

join : List (List a) -> List a

Join the given lists together into one list.

expect List.join [[1], [2, 3], [], [4, 5]] == [1, 2, 3, 4, 5]
expect List.join [[], []] == []
expect List.join [] == []

contains : List a, a -> Bool where a implements Eq

walk : List elem, state, (state, elem -> state) -> state

Build a value using each element in the list.

Starting with a given state value, this walks through each element in the list from first to last, running a given step function on that element which updates the state. It returns the final state at the end.

You can use it in a pipeline:

[2, 4, 8]
    |> List.walk 0 Num.add

This returns 14 because:

• state starts at 0
• Each step runs Num.add state elem, and the return value becomes the new state.

Here is a table of how state changes as List.walk walks over the elements [2, 4, 8] using Num.add as its step function to determine the next state.

The following returns -6:

[1, 2, 3]
    |> List.walk 0 Num.sub

Note that in other languages, walk is sometimes called reduce, fold, foldLeft, or foldl.

walkWithIndex : List elem, state, (state, elem, U64 -> state) -> state

Like walk, but at each step the function also receives the index of the current element.

walkWithIndexUntil : List elem, state, (state, elem, U64 -> [ Continue state, Break state ]) -> state

Like walkUntil, but at each step the function also receives the index of the current element.

walkBackwards : List elem, state, (state, elem -> state) -> state

Note that in other languages, walkBackwards is sometimes called reduceRight, fold, foldRight, or foldr.

walkUntil : List elem, state, (state, elem -> [ Continue state, Break state ]) -> state

Same as List.walk, except you can stop walking early.

Performance Details

Compared to List.walk, this can potentially visit fewer elements (which can improve performance) at the cost of making each step take longer. However, the added cost to each step is extremely small, and can easily be outweighed if it results in skipping even a small number of elements.

As such, it is typically better for performance to use this over List.walk if returning Break earlier than the last element is expected to be common.

walkBackwardsUntil : List elem, state, (state, elem -> [ Continue state, Break state ]) -> state

Same as List.walkUntil, but does it from the end of the list instead.

walkFrom : List elem, U64, state, (state, elem -> state) -> state

Walks to the end of the list from a specified starting index

walkFromUntil : List elem, U64, state, (state, elem -> [ Continue state, Break state ]) -> state

A combination of List.walkFrom and List.walkUntil

sum : List (Num a) -> Num a

product : List (Num a) -> Num a

any : List a, (a -> Bool) -> Bool

Run the given predicate on each element of the list, returning Bool.true if any of the elements satisfy it.

all : List a, (a -> Bool) -> Bool

Run the given predicate on each element of the list, returning Bool.true if all of the elements satisfy it.

keepIf : List a, (a -> Bool) -> List a

Run the given function on each element of a list, and return all the elements for which the function returned Bool.true.

List.keepIf [1, 2, 3, 4] (\num -> num > 2)

Performance Details

List.keepIf always returns a list that takes up exactly the same amount of memory as the original, even if its length decreases. This is because it can't know in advance exactly how much space it will need, and if it guesses a length that's too low, it would have to re-allocate.

(If you want to do an operation like this which reduces the memory footprint of the resulting list, you can do two passes over the list with List.walk - one to calculate the precise new size, and another to populate the new list.)

If given a unique list, List.keepIf will mutate it in place to assemble the appropriate list. If that happens, this function will not allocate any new memory on the heap. If all elements in the list end up being kept, Roc will return the original list unaltered.

dropIf : List a, (a -> Bool) -> List a

Run the given function on each element of a list, and return all the elements for which the function returned Bool.false.

List.dropIf [1, 2, 3, 4] (\num -> num > 2)

Performance Details

List.dropIf has the same performance characteristics as List.keepIf. See its documentation for details on those characteristics!

countIf : List a, (a -> Bool) -> U64

Run the given function on each element of a list, and return the number of elements for which the function returned Bool.true.

expect List.countIf [1, -2, -3] Num.isNegative == 2
expect List.countIf [1, 2, 3] (\num -> num > 1 ) == 2

keepOks : List before, (before -> Result after *) -> List after

This works like List.map, except only the transformed values that are wrapped in Ok are kept. Any that are wrapped in Err are dropped.

expect List.keepOks ["1", "Two", "23", "Bird"] Str.toI32 == [1, 23]

expect List.keepOks [["a", "b"], [], ["c", "d", "e"], [] ] List.first == ["a", "c"]

fn = \str -> if Str.isEmpty str then Err StrWasEmpty else Ok str
expect List.keepOks ["", "a", "bc", "", "d", "ef", ""] fn == ["a", "bc", "d", "ef"]

keepErrs : List before, (before -> Result * after) -> List after

This works like List.map, except only the transformed values that are wrapped in Err are kept. Any that are wrapped in Ok are dropped.

List.keepErrs [["a", "b"], [], [], ["c", "d", "e"]] List.last

fn = \str -> if Str.isEmpty str then Err StrWasEmpty else Ok (Str.len str)

List.keepErrs ["", "a", "bc", "", "d", "ef", ""]

map : List a, (a -> b) -> List b

Convert each element in the list to something new, by calling a conversion function on each of them. Then return a new list of the converted values.

expect List.map [1, 2, 3] (\num -> num + 1) == [2, 3, 4]

expect List.map ["", "a", "bc"] Str.isEmpty == [Bool.true, Bool.false, Bool.false]

map2 : List a, List b, (a, b -> c) -> List c

Run a transformation function on the first element of each list, and use that as the first element in the returned list. Repeat until a list runs out of elements.

Some languages have a function named zip, which does something similar to calling List.map2 passing two lists and Pair:

zipped = List.map2 ["a", "b", "c"] [1, 2, 3] Pair

map3 : List a, List b, List c, (a, b, c -> d) -> List d

Run a transformation function on the first element of each list, and use that as the first element in the returned list. Repeat until a list runs out of elements.

map4 : List a, List b, List c, List d, (a, b, c, d -> e) -> List e

Run a transformation function on the first element of each list, and use that as the first element in the returned list. Repeat until a list runs out of elements.

mapWithIndex : List a, (a, U64 -> b) -> List b

This works like List.map, except it also passes the index of the element to the conversion function.

expect List.mapWithIndex [10, 20, 30] (\num, index -> num + index) == [10, 21, 32]

range

Returns a list of all the integers between start and end.

To include the start and end integers themselves, use At like so:

List.range { start: At 2, end: At 5 } # returns [2, 3, 4, 5]

To exclude them, use After and Before, like so:

List.range { start: After 2, end: Before 5 } # returns [3, 4]

You can have the list end at a certain length rather than a certain integer:

List.range { start: At 6, end: Length 4 } # returns [6, 7, 8, 9]

If step is specified, each integer increases by that much. (step: 1 is the default.)

List.range { start: After 0, end: Before 9, step: 3 } # returns [3, 6]

List.range will also generate a reversed list if step is negative or end comes before start:

List.range { start: At 5, end: At 2 } # returns [5, 4, 3, 2]

All of these options are compatible with the others. For example, you can use At or After with start regardless of what end and step are set to.

sortWith : List a, (a, a -> [ LT, EQ, GT ]) -> List a

Sort with a custom comparison function

sortAsc : List (Num a) -> List (Num a)

Sorts a list of numbers in ascending order (lowest to highest).

To sort in descending order (highest to lowest), use List.sortDesc instead.

sortDesc : List (Num a) -> List (Num a)

Sorts a list of numbers in descending order (highest to lowest).

To sort in ascending order (lowest to highest), use List.sortAsc instead.

swap : List a, U64, U64 -> List a

first : List a -> Result a [ListWasEmpty]

Returns the first element in the list, or ListWasEmpty if it was empty.

takeFirst : List elem, U64 -> List elem

Returns the given number of elements from the beginning of the list.

List.takeFirst [1, 2, 3, 4, 5, 6, 7, 8] 4

If there are fewer elements in the list than the requested number, returns the entire list.

List.takeFirst [1, 2] 5

To remove elements from the beginning of the list, use List.takeLast.

To remove elements from both the beginning and end of the list, use List.sublist.

To split the list into two lists, use List.split.

takeLast : List elem, U64 -> List elem

Returns the given number of elements from the end of the list.

List.takeLast [1, 2, 3, 4, 5, 6, 7, 8] 4

If there are fewer elements in the list than the requested number, returns the entire list.

List.takeLast [1, 2] 5

To remove elements from the end of the list, use List.takeFirst.

To remove elements from both the beginning and end of the list, use List.sublist.

To split the list into two lists, use List.split.

dropFirst : List elem, U64 -> List elem

Drops n elements from the beginning of the list.

dropLast : List elem, U64 -> List elem

Drops n elements from the end of the list.

dropAt : List elem, U64 -> List elem

Drops the element at the given index from the list.

This has no effect if the given index is outside the bounds of the list.

To replace the element at a given index, instead of dropping it, see List.set.

min : List (Num a) -> Result (Num a) [ListWasEmpty]

max : List (Num a) -> Result (Num a) [ListWasEmpty]

joinMap : List a, (a -> List b) -> List b

Like List.map, except the transformation function wraps the return value in a list. At the end, all the lists get joined together into one list.

You may know a similar function named concatMap in other languages.

findFirst : List elem, (elem -> Bool) -> Result elem [NotFound]

Returns the first element of the list satisfying a predicate function. If no satisfying element is found, an Err NotFound is returned.

findLast : List elem, (elem -> Bool) -> Result elem [NotFound]

Returns the last element of the list satisfying a predicate function. If no satisfying element is found, an Err NotFound is returned.

findFirstIndex : List elem, (elem -> Bool) -> Result U64 [NotFound]

Returns the index at which the first element in the list satisfying a predicate function can be found. If no satisfying element is found, an Err NotFound is returned.

findLastIndex : List elem, (elem -> Bool) -> Result U64 [NotFound]

Returns the last index at which the first element in the list satisfying a predicate function can be found. If no satisfying element is found, an Err NotFound is returned.

sublist : List elem, { start : U64, len : U64 } -> List elem

Returns a subsection of the given list, beginning at the start index and including a total of len elements.

If start is outside the bounds of the given list, returns the empty list.

List.sublist [1, 2, 3] { start: 4, len: 0 }

If more elements are requested than exist in the list, returns as many as it can.

List.sublist [1, 2, 3, 4, 5] { start: 2, len: 10 }

If you want a sublist which goes all the way to the end of the list, no matter how long the list is, List.takeLast can do that more efficiently.

Some languages have a function called slice which works similarly to this.

intersperse : List elem, elem -> List elem

Intersperses sep between the elements of list

List.intersperse [1, 2, 3] 9     # [1, 9, 2, 9, 3]

startsWith : List elem, List elem -> Bool where elem implements Eq

Returns Bool.true if the first list starts with the second list.

If the second list is empty, this always returns Bool.true; every list is considered to "start with" an empty list.

If the first list is empty, this only returns Bool.true if the second list is empty.

endsWith : List elem, List elem -> Bool where elem implements Eq

Returns Bool.true if the first list ends with the second list.

If the second list is empty, this always returns Bool.true; every list is considered to "end with" an empty list.

If the first list is empty, this only returns Bool.true if the second list is empty.

split : List elem, U64 -> { before : List elem, others : List elem }

Splits the list into two lists, around the given index.

The returned lists are labeled before and others. The before list will contain all the elements whose index in the original list was less than than the given index, # and the others list will be all the others. (This means if you give an index of 0, the before list will be empty and the others list will have the same elements as the original list.)

splitFirst : List elem, elem -> Result { before : List elem, after : List elem } [NotFound] where elem implements Eq

Returns the elements before the first occurrence of a delimiter, as well as the remaining elements after that occurrence. If the delimiter is not found, returns Err.

List.splitFirst [Foo, Z, Bar, Z, Baz] Z == Ok { before: [Foo], after: [Bar, Z, Baz] }

splitLast : List elem, elem -> Result { before : List elem, after : List elem } [NotFound] where elem implements Eq

Returns the elements before the last occurrence of a delimiter, as well as the remaining elements after that occurrence. If the delimiter is not found, returns Err.

List.splitLast [Foo, Z, Bar, Z, Baz] Z == Ok { before: [Foo, Z, Bar], after: [Baz] }

chunksOf : List a, U64 -> List (List a)

Splits the list into many chunks, each of which is length of the given chunk size. The last chunk will be shorter if the list does not evenly divide by the chunk size. If the provided list is empty or if the chunk size is 0 then the result is an empty list.

mapTry : List elem, (elem -> Result ok err) -> Result (List ok) err

Like List.map, except the transformation function returns a Result. If that function ever returns Err, mapTry immediately returns that Err. If it returns Ok for every element, mapTry returns Ok with the transformed list.

walkTry : List elem, state, (state, elem -> Result state err) -> Result state err

Same as List.walk, except you can stop walking early by returning Err.

Performance Details

Compared to List.walk, this can potentially visit fewer elements (which can improve performance) at the cost of making each step take longer. However, the added cost to each step is extremely small, and can easily be outweighed if it results in skipping even a small number of elements.

As such, it is typically better for performance to use this over List.walk if returning Break earlier than the last element is expected to be common.

concatUtf8 : List U8, Str -> List U8

Concatenates the bytes of a string encoded as utf8 to a list of bytes.

expect (List.concatUtf8 [1, 2, 3, 4] "🐦") == [1, 2, 3, 4, 240, 159, 144, 166]

forEach! : List a, (a => {}) => {}

Run an effectful function for each element on the list.

List.forEach! ["Alice", "Bob", "Charlie"] \name ->
    createAccount! name
    log! "Account created"

If the function might fail or you need to return early, use forEachTry!.

forEachTry! : List a, (a => Result {} err) => Result {} err

Run an effectful function that might fail for each element on the list.

If the function returns Err, the iteration stops and the error is returned.

List.forEachTry! filesToDelete \path ->
    try File.delete! path
    Stdout.line! "$(path) deleted"