ds (erlang_ds v0.4.2)

View Source

Summary

Types

default_value()
key()
key_map()
key_value_tuple()
key_value_tuples()
keys()
obj_type()
object()
proplist()
transform_list()
transform_tuple()
unmerged_object()
update_action()
updater_key()
updater_mod_fun()
value()
values()

Functions

compare/3
delete/2
delete_list/2
dict_test_()
filter/2
foreach/2
get(Obj, Key)
get/3
get_list(Obj, Keys)
get_list(Obj, Keys, Default)
guess_merge/1
guess_merge(A, B)
has_key/2
keep(Obj, Keys)
map/2
map_test_()
merge(List)
merge(A, B)
pl_test_()
register_qdate_updaters()
register_type_handler(Module)
register_type_test_()
register_updater(UpdaterKey, MFA)
register_updaters(KeyMFAs)
rekey/2
rekey(Obj, FromKey, ToKey)
set/2
set(Obj, Key, Val)
test_multiarg_updater(Exponent, Subtract, Val)
test_subtract(X, Val)
to_list/1
to_map/1
to_type/2
transform/2
type/1
unregister_qdate_updaters()
unregister_type_handler(Module)
unregister_updater(UpdaterKey)
unregister_updaters(Keys)
update/3

Types

default_value()

-type default_value() :: value().

key()

-type key() :: any().

key_map()

-type key_map() :: [{key(), key()}].

key_value_tuple()

-type key_value_tuple() :: {key(), value()}.

key_value_tuples()

-type key_value_tuples() :: [key_value_tuple()].

keys()

-type keys() :: [key()].

obj_type()

-type obj_type() :: list | map | atom().

object()

-type object() :: list() | map() | any().

proplist()

-type proplist() :: [{key(), value()}].

transform_list()

-type transform_list() :: [transform_tuple()].

transform_tuple()

-type transform_tuple() :: {update_action(), keys()}.

unmerged_object()

-type unmerged_object() :: object().

update_action()

-type update_action() :: function() | updater_mod_fun() | updater_key().

updater_key()

-type updater_key() :: atom() | tuple().

updater_mod_fun()

-type updater_mod_fun() :: {atom(), atom()}.

value()

-type value() :: any().

values()

-type values() :: [value()].

Functions

compare/3

delete/2

-spec delete(object(), key()) -> object().

delete_list/2

-spec delete_list(object(), keys()) -> object().

dict_test_()

filter/2

-spec filter(object(), fun()) -> object().

foreach/2

-spec foreach(object(), fun()) -> ok.

get(Obj, Key)

-spec get(object(), key()) -> value().

get/3

-spec get(object(), key(), default_value()) -> value().

get_list(Obj, Keys)

-spec get_list(object(), keys()) -> values().

get_list(Obj, Keys, Default)

-spec get_list(object(), keys(), default_value()) -> values().

guess_merge/1

-spec guess_merge([object()]) -> object().

guess_merge(A, B)

-spec guess_merge(object(), object()) -> object().

has_key/2

-spec has_key(object(), key()) -> boolean().

keep(Obj, Keys)

-spec keep(object(), keys()) -> object().

map/2

-spec map(object(), fun()) -> object().

map_test_()

merge(List)

-spec merge([object()]) -> {object(), unmerged_object()}.

merge(A, B)

-spec merge(object(), object()) -> {object(), unmerged_object()}.

pl_test_()

register_qdate_updaters()

register_type_handler(Module)

register_type_test_()

register_updater(UpdaterKey, MFA)

register_updaters(KeyMFAs)

rekey/2

-spec rekey(object(), key_map()) -> object().

rekey(Obj, FromKey, ToKey)

-spec rekey(object(), FromKey :: key(), ToKey :: key()) -> object().

set/2

-spec set(object(), key_value_tuple() | key_value_tuples() | object()) -> object().

set(Obj, Key, Val)

-spec set(object(), key(), value()) -> object().

test_multiarg_updater(Exponent, Subtract, Val)

test_subtract(X, Val)

to_list/1

-spec to_list(object()) -> proplist().

to_map/1

-spec to_map(object()) -> map().

to_type/2

-spec to_type(obj_type(), object()) -> object().

transform/2

-spec transform(object(), transform_list()) -> object().

type/1

-spec type(object()) -> obj_type().

unregister_qdate_updaters()

unregister_type_handler(Module)

unregister_updater(UpdaterKey)

unregister_updaters(Keys)

update/3

-spec update(object(), key() | keys(), update_action()) -> object().