Packages
gleam_stdlib
0.28.0
1.0.3
1.0.2
1.0.1
1.0.0
0.71.0
0.70.0
0.69.0
0.68.1
0.68.0
0.67.1
0.67.0
0.65.0
0.64.0
0.63.2
0.63.1
0.63.0
0.62.1
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.50.0
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.43.0
0.42.0
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.1
0.35.0
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.0
0.30.2
0.30.1
0.30.0
0.29.2
0.29.1
0.29.0
0.28.2
0.28.1
0.28.0
0.27.0
0.26.1
0.26.0
0.25.0
0.24.0
0.23.0
0.22.3
0.22.2
0.22.1
0.22.0
0.21.0
0.20.0
0.19.3
0.19.2
0.19.1
0.19.0
0.18.1
0.18.0
0.18.0-rc1
0.17.1
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.4.0-rc1
0.3.1
0.3.0
0.2.0
retired
A standard library for the Gleam programming language
Current section
Files
Jump to
Current section
Files
src/gleam/map.gleam
import gleam/option.{Option}
/// A dictionary of keys and values.
///
/// Any type can be used for the keys and values of a map, but all the keys
/// must be of the same type and all the values must be of the same type.
///
/// Each key can only be present in a map once.
///
/// Maps are not ordered in any way, and any unintentional ordering is not to
/// be relied upon in your code as it may change in future versions of Erlang
/// or Gleam.
///
/// See [the Erlang map module](https://erlang.org/doc/man/maps.html) for more
/// information.
///
pub external type Map(key, value)
/// Determines the number of key-value pairs in the map.
/// This function runs in constant time and does not need to iterate the map.
///
/// ## Examples
///
/// ```gleam
/// > new() |> size()
/// 0
/// ```
///
/// ```gleam
/// > new() |> insert("key", "value") |> size()
/// 1
/// ```
///
pub fn size(map: Map(k, v)) -> Int {
do_size(map)
}
if erlang {
external fn do_size(Map(k, v)) -> Int =
"maps" "size"
}
if javascript {
external fn do_size(Map(k, v)) -> Int =
"../gleam_stdlib.mjs" "map_size"
}
/// Converts the map to a list of 2-element tuples `#(key, value)`, one for
/// each key-value pair in the map.
///
/// The tuples in the list have no specific order.
///
/// ## Examples
///
/// ```gleam
/// > new() |> to_list()
/// []
/// ```
///
/// ```gleam
/// > new() |> insert("key", 0) |> to_list()
/// [#("key", 0)]
/// ```
///
pub fn to_list(map: Map(key, value)) -> List(#(key, value)) {
do_to_list(map)
}
if erlang {
external fn do_to_list(Map(key, value)) -> List(#(key, value)) =
"maps" "to_list"
}
if javascript {
external fn do_to_list(Map(key, value)) -> List(#(key, value)) =
"../gleam_stdlib.mjs" "map_to_list"
}
/// Converts a list of 2-element tuples `#(key, value)` to a map.
///
/// If two tuples have the same key the last one in the list will be the one
/// that is present in the map.
///
pub fn from_list(list: List(#(k, v))) -> Map(k, v) {
do_from_list(list)
}
if erlang {
external fn do_from_list(List(#(key, value))) -> Map(key, value) =
"maps" "from_list"
}
if javascript {
fn fold_list_of_pair(
over list: List(#(k, v)),
from initial: Map(k, v),
) -> Map(k, v) {
case list {
[] -> initial
[x, ..rest] -> fold_list_of_pair(rest, insert(initial, x.0, x.1))
}
}
fn do_from_list(list: List(#(k, v))) -> Map(k, v) {
fold_list_of_pair(list, new())
}
}
/// Determines whether or not a value present in the map for a given key.
///
/// ## Examples
///
/// ```gleam
/// > new() |> insert("a", 0) |> has_key("a")
/// True
/// ```
///
/// ```gleam
/// > new() |> insert("a", 0) |> has_key("b")
/// False
/// ```
///
pub fn has_key(map: Map(k, v), key: k) -> Bool {
do_has_key(key, map)
}
if erlang {
external fn do_has_key(key, Map(key, v)) -> Bool =
"maps" "is_key"
}
if javascript {
fn do_has_key(key: k, map: Map(k, v)) -> Bool {
get(map, key) != Error(Nil)
}
}
/// Creates a fresh map that contains no values.
///
pub fn new() -> Map(key, value) {
do_new()
}
if erlang {
external fn do_new() -> Map(key, value) =
"maps" "new"
}
if javascript {
external fn do_new() -> Map(key, value) =
"../gleam_stdlib.mjs" "new_map"
}
/// Fetches a value from a map for a given key.
///
/// The map may not have a value for the key, so the value is wrapped in a
/// `Result`.
///
/// ## Examples
///
/// ```gleam
/// > new() |> insert("a", 0) |> get("a")
/// Ok(0)
/// ```
///
/// ```gleam
/// > new() |> insert("a", 0) |> get("b")
/// Error(Nil)
/// ```
///
pub fn get(from: Map(key, value), get: key) -> Result(value, Nil) {
do_get(from, get)
}
if erlang {
external fn do_get(Map(key, value), key) -> Result(value, Nil) =
"gleam_stdlib" "map_get"
}
if javascript {
external fn do_get(Map(key, value), key) -> Result(value, Nil) =
"../gleam_stdlib.mjs" "map_get"
}
/// Inserts a value into the map with the given key.
///
/// If the map already has a value for the given key then the value is
/// replaced with the new value.
///
/// ## Examples
///
/// ```gleam
/// > new() |> insert("a", 0) |> to_list
/// [#("a", 0)]
/// ```
///
/// ```gleam
/// > new() |> insert("a", 0) |> insert("a", 5) |> to_list
/// [#("a", 5)]
/// ```
///
pub fn insert(into map: Map(k, v), for key: k, insert value: v) -> Map(k, v) {
do_insert(key, value, map)
}
if erlang {
external fn do_insert(key, value, Map(key, value)) -> Map(key, value) =
"maps" "put"
}
if javascript {
external fn do_insert(key, value, Map(key, value)) -> Map(key, value) =
"../gleam_stdlib.mjs" "map_insert"
}
/// Updates all values in a given map by calling a given function on each key
/// and value.
///
/// ## Examples
///
/// ```gleam
/// > [#(3, 3), #(2, 4)]
/// > |> from_list
/// > |> map_values(fn(key, value) { key * value })
/// [#(3, 9), #(2, 8)]
/// ```
///
pub fn map_values(in map: Map(k, v), with fun: fn(k, v) -> w) -> Map(k, w) {
do_map_values(fun, map)
}
if erlang {
external fn do_map_values(fn(key, value) -> b, Map(key, value)) -> Map(key, b) =
"maps" "map"
}
if javascript {
fn do_map_values(f: fn(key, value) -> b, map: Map(key, value)) -> Map(key, b) {
let f = fn(map, k, v) { insert(map, k, f(k, v)) }
map
|> fold(from: new(), with: f)
}
}
/// Gets a list of all keys in a given map.
///
/// Maps are not ordered so the keys are not returned in any specific order. Do
/// not write code that relies on the order keys are returned by this function
/// as it may change in later versions of Gleam or Erlang.
///
/// ## Examples
///
/// ```gleam
/// > keys([#("a", 0), #("b", 1)])
/// ["a", "b"]
/// ```
///
pub fn keys(map: Map(keys, v)) -> List(keys) {
do_keys(map)
}
if erlang {
external fn do_keys(Map(keys, v)) -> List(keys) =
"maps" "keys"
}
if javascript {
fn reverse_and_concat(remaining, accumulator) {
case remaining {
[] -> accumulator
[item, ..rest] -> reverse_and_concat(rest, [item, ..accumulator])
}
}
fn do_keys_acc(list: List(#(k, v)), acc: List(k)) -> List(k) {
case list {
[] -> reverse_and_concat(acc, [])
[x, ..xs] -> do_keys_acc(xs, [x.0, ..acc])
}
}
fn do_keys(map: Map(k, v)) -> List(k) {
let list_of_pairs =
map
|> to_list
do_keys_acc(list_of_pairs, [])
}
}
/// Gets a list of all values in a given map.
///
/// Maps are not ordered so the values are not returned in any specific order. Do
/// not write code that relies on the order values are returned by this function
/// as it may change in later versions of Gleam or Erlang.
///
/// ## Examples
///
/// ```gleam
/// > values(from_list([#("a", 0), #("b", 1)]))
/// [0, 1]
/// ```
///
pub fn values(map: Map(k, values)) -> List(values) {
do_values(map)
}
if erlang {
external fn do_values(Map(k, values)) -> List(values) =
"maps" "values"
}
if javascript {
fn do_values_acc(list: List(#(k, v)), acc: List(v)) -> List(v) {
case list {
[] -> reverse_and_concat(acc, [])
[x, ..xs] -> do_values_acc(xs, [x.1, ..acc])
}
}
fn do_values(map: Map(k, v)) -> List(v) {
let list_of_pairs =
map
|> to_list
do_values_acc(list_of_pairs, [])
}
}
/// Creates a new map from a given map, minus any entries that a given function
/// returns `False` for.
///
/// ## Examples
///
/// ```gleam
/// > from_list([#("a", 0), #("b", 1)])
/// > |> filter(fn(key, value) { value != 0 })
/// from_list([#("b", 1)])
/// ```
///
/// ```gleam
/// > from_list([#("a", 0), #("b", 1)])
/// > |> filter(fn(key, value) { True })
/// from_list([#("a", 0), #("b", 1)])
/// ```
///
pub fn filter(in map: Map(k, v), for property: fn(k, v) -> Bool) -> Map(k, v) {
do_filter(property, map)
}
if erlang {
external fn do_filter(
fn(key, value) -> Bool,
Map(key, value),
) -> Map(key, value) =
"maps" "filter"
}
if javascript {
fn do_filter(
f: fn(key, value) -> Bool,
map: Map(key, value),
) -> Map(key, value) {
let insert = fn(map, k, v) {
case f(k, v) {
True -> insert(map, k, v)
_ -> map
}
}
map
|> fold(from: new(), with: insert)
}
}
/// Creates a new map from a given map, only including any entries for which the
/// keys are in a given list.
///
/// ## Examples
///
/// ```gleam
/// > from_list([#("a", 0), #("b", 1)])
/// > |> take(["b"])
/// from_list([#("b", 1)])
/// ```
///
/// ```gleam
/// > from_list([#("a", 0), #("b", 1)])
/// > |> take(["a", "b", "c"])
/// from_list([#("a", 0), #("b", 1)])
/// ```
///
pub fn take(from map: Map(k, v), keeping desired_keys: List(k)) -> Map(k, v) {
do_take(desired_keys, map)
}
if erlang {
external fn do_take(List(k), Map(k, v)) -> Map(k, v) =
"maps" "with"
}
if javascript {
fn insert_taken(
map: Map(k, v),
desired_keys: List(k),
acc: Map(k, v),
) -> Map(k, v) {
let insert = fn(taken, key) {
case get(map, key) {
Ok(value) -> insert(taken, key, value)
_ -> taken
}
}
case desired_keys {
[] -> acc
[x, ..xs] -> insert_taken(map, xs, insert(acc, x))
}
}
fn do_take(desired_keys: List(k), map: Map(k, v)) -> Map(k, v) {
insert_taken(map, desired_keys, new())
}
}
/// Creates a new map from a pair of given maps by combining their entries.
///
/// If there are entries with the same keys in both maps the entry from the
/// second map takes precedence.
///
/// ## Examples
///
/// ```gleam
/// > let a = from_list([#("a", 0), #("b", 1)])
/// > let b = from_list([#("b", 2), #("c", 3)])
/// > merge(a, b)
/// from_list([#("a", 0), #("b", 2), #("c", 3)])
/// ```
///
pub fn merge(into map: Map(k, v), from new_entries: Map(k, v)) -> Map(k, v) {
do_merge(map, new_entries)
}
if erlang {
external fn do_merge(Map(k, v), Map(k, v)) -> Map(k, v) =
"maps" "merge"
}
if javascript {
fn insert_pair(map: Map(k, v), pair: #(k, v)) -> Map(k, v) {
insert(map, pair.0, pair.1)
}
fn fold_inserts(new_entries: List(#(k, v)), map: Map(k, v)) -> Map(k, v) {
case new_entries {
[] -> map
[x, ..xs] -> fold_inserts(xs, insert_pair(map, x))
}
}
fn do_merge(map: Map(k, v), new_entries: Map(k, v)) -> Map(k, v) {
new_entries
|> to_list
|> fold_inserts(map)
}
}
/// Creates a new map from a given map with all the same entries except for the
/// one with a given key, if it exists.
///
/// ## Examples
///
/// ```gleam
/// > delete([#("a", 0), #("b", 1)], "a")
/// from_list([#("b", 1)])
/// ```
///
/// ```gleam
/// > delete([#("a", 0), #("b", 1)], "c")
/// from_list([#("a", 0), #("b", 1)])
/// ```
///
pub fn delete(from map: Map(k, v), delete key: k) -> Map(k, v) {
do_delete(key, map)
}
if erlang {
external fn do_delete(k, Map(k, v)) -> Map(k, v) =
"maps" "remove"
}
if javascript {
external fn do_delete(k, Map(k, v)) -> Map(k, v) =
"../gleam_stdlib.mjs" "map_remove"
}
/// Creates a new map from a given map with all the same entries except any with
/// keys found in a given list.
///
/// ## Examples
///
/// ```gleam
/// > drop([#("a", 0), #("b", 1)], ["a"])
/// from_list([#("b", 2)])
/// ```
///
/// ```gleam
/// > delete([#("a", 0), #("b", 1)], ["c"])
/// from_list([#("a", 0), #("b", 1)])
/// ```
///
/// ```gleam
/// > drop([#("a", 0), #("b", 1)], ["a", "b", "c"])
/// from_list([])
/// ```
///
pub fn drop(from map: Map(k, v), drop disallowed_keys: List(k)) -> Map(k, v) {
case disallowed_keys {
[] -> map
[x, ..xs] -> drop(delete(map, x), xs)
}
}
/// Creates a new map with one entry updated using a given function.
///
/// If there was not an entry in the map for the given key then the function
/// gets `None` as its argument, otherwise it gets `Some(value)`.
///
/// ## Example
///
/// ```gleam
/// > let increment = fn(x) {
/// > case x {
/// > Some(i) -> i + 1
/// > None -> 0
/// > }
/// > }
/// > let map = from_list([#("a", 0)])
/// >
/// > update(map, "a", increment)
/// from_list([#("a", 1)])
/// ```
///
/// ```gleam
/// > update(map, "b", increment)
/// from_list([#("a", 0), #("b", 0)])
/// ```
///
pub fn update(
in map: Map(k, v),
update key: k,
with fun: fn(Option(v)) -> v,
) -> Map(k, v) {
map
|> get(key)
|> option.from_result
|> fun
|> insert(map, key, _)
}
fn do_fold(list: List(#(k, v)), initial: acc, fun: fn(acc, k, v) -> acc) -> acc {
case list {
[] -> initial
[#(k, v), ..tail] -> do_fold(tail, fun(initial, k, v), fun)
}
}
/// Combines all entries into a single value by calling a given function on each
/// one.
///
/// Maps are not ordered so the values are not returned in any specific order. Do
/// not write code that relies on the order entries are used by this function
/// as it may change in later versions of Gleam or Erlang.
///
/// # Examples
///
/// ```gleam
/// > let map = from_list([#("a", 1), #("b", 3), #("c", 9)])
/// > fold(map, 0, fn(accumulator, key, value) { accumulator + value })
/// 13
/// ```
///
/// ```gleam
/// > import gleam/string.{append}
/// > fold(map, "", fn(accumulator, key, value) { append(accumulator, key) })
/// "abc"
/// ```
///
pub fn fold(
over map: Map(k, v),
from initial: acc,
with fun: fn(acc, k, v) -> acc,
) -> acc {
map
|> to_list
|> do_fold(initial, fun)
}