W3cubDocs

/Elixir 1.18

Source Dict

This module is deprecated. Use Map or Keyword modules instead.

Generic API for dictionaries.

If you need a general dictionary, use the Map module. If you need to manipulate keyword lists, use Keyword.

To convert maps into keywords and vice-versa, use the new function in the respective modules.

Summary

Types

key()
t()
value()

Functions

delete(dict, key) deprecated
drop(dict, keys) deprecated
empty(dict) deprecated
equal?(dict1, dict2) deprecated
fetch(dict, key) deprecated
fetch!(dict, key) deprecated
get(dict, key, default \\ nil) deprecated
get_and_update(dict, key, fun) deprecated
get_lazy(dict, key, fun) deprecated
has_key?(dict, key) deprecated
keys(dict) deprecated
merge(dict1, dict2) deprecated
merge(dict1, dict2, fun) deprecated
pop(dict, key, default \\ nil) deprecated
pop_lazy(dict, key, fun) deprecated
put(dict, key, val) deprecated
put_new(dict, key, val) deprecated
put_new_lazy(dict, key, fun) deprecated
size(dict) deprecated
split(dict, keys) deprecated
take(dict, keys) deprecated
to_list(dict) deprecated
update(dict, key, default, fun) deprecated
update!(dict, key, fun) deprecated
values(dict) deprecated

Types

key()Source

@type key() :: any()

t()Source

@type t() :: list() | map()

value()Source

@type value() :: any()

Functions

delete(dict, key)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec delete(t(), key()) :: t()

drop(dict, keys)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec drop(t(), [key()]) :: t()

empty(dict)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec empty(t()) :: t()

equal?(dict1, dict2)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec equal?(t(), t()) :: boolean()

fetch(dict, key)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec fetch(t(), key()) :: value()

fetch!(dict, key)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec fetch!(t(), key()) :: value()

get(dict, key, default \\ nil)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec get(t(), key(), value()) :: value()

get_and_update(dict, key, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec get_and_update(t(), key(), (value() -> {value(), value()})) :: {value(), t()}

get_lazy(dict, key, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec get_lazy(t(), key(), (-> value())) :: value()

has_key?(dict, key)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec has_key?(t(), key()) :: boolean()

keys(dict)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec keys(t()) :: [key()]

merge(dict1, dict2)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec merge(t(), t()) :: t()

merge(dict1, dict2, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec merge(t(), t(), (key(), value(), value() -> value())) :: t()

pop(dict, key, default \\ nil)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec pop(t(), key(), value()) :: {value(), t()}

pop_lazy(dict, key, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec pop_lazy(t(), key(), (-> value())) :: {value(), t()}

put(dict, key, val)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec put(t(), key(), value()) :: t()

put_new(dict, key, val)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec put_new(t(), key(), value()) :: t()

put_new_lazy(dict, key, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec put_new_lazy(t(), key(), (-> value())) :: t()

size(dict)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec size(t()) :: non_neg_integer()

split(dict, keys)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec split(t(), [key()]) :: {t(), t()}

take(dict, keys)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec take(t(), [key()]) :: t()

to_list(dict)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec to_list(t()) :: list()

update(dict, key, default, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec update(t(), key(), value(), (value() -> value())) :: t()

update!(dict, key, fun)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec update!(t(), key(), (value() -> value())) :: t()

values(dict)Source

This function is deprecated. Use the Map module for working with maps or the Keyword module for working with keyword lists.

@spec values(t()) :: [value()]

© 2012-2024 The Elixir Team
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.18.1/Dict.html