Map

Introduction #

A Dict implementation that works on maps.

Maps are key-value stores where keys are compared using the match operator (===). Maps can be created with the %{} special form defined in the Kernel.SpecialForms module.

For more information about the functions in this module and their APIs, please consult the Dict module.

Source

Functions #

delete(map, key)

(function)

Callback implementation of Dict.delete/2.

drop(dict, keys)

(function)

Callback implementation of Dict.drop/2.

equal?(dict1, dict2)

(function)

Callback implementation of Dict.equal?/2.

fetch(map, key)

(function)

Callback implementation of Dict.fetch/2.

fetch!(dict, key)

(function)

Callback implementation of Dict.fetch!/2.

from_struct(struct)

(function)

Converts a struct to map.

It accepts the struct module or a struct itself and simply removes the __struct__ field from the struct.

Example

defmodule User do
  defstruct [:name]
end

Map.from_struct(User)
#=> %{name: nil}

Map.from_struct(%User{name: "john"})
#=> %{name: "john"}

get(dict, key, default \\ nil)

(function)

Callback implementation of Dict.get/3.

has_key?(dict, key)

(function)

Callback implementation of Dict.has_key?/2.

keys(dict)

(function)

Callback implementation of Dict.keys/1.

merge(map1, map2)

(function)

Callback implementation of Dict.merge/2.

merge(dict1, dict2, fun \\ fn _k, _v1, v2 -> v2 end)

(function)

Callback implementation of Dict.merge/3.

new()

(function)

Returns a new empty map.

pop(dict, key, default \\ nil)

(function)

Callback implementation of Dict.pop/3.

put(map, key, val)

(function)

Callback implementation of Dict.put/3.

put_new(dict, key, value)

(function)

Callback implementation of Dict.put_new/3.

size(map)

(function)

Callback implementation of Dict.size/1.

split(dict, keys)

(function)

Callback implementation of Dict.split/2.

take(dict, keys)

(function)

Callback implementation of Dict.take/2.

to_list(dict)

(function)

Callback implementation of Dict.to_list/1.

update(dict, key, initial, fun)

(function)

Callback implementation of Dict.update/4.

update!(dict, key, fun)

(function)

Callback implementation of Dict.update!/3.

values(dict)

(function)

Callback implementation of Dict.values/1.