View Source ds (erlang_ds v0.3.0)

Link to this section Summary

Link to this section Types

-type default_value() :: value().
-type key() :: any().
-type key_map() :: [{key(), key()}].
-type key_value_tuple() :: {key(), value()}.
-type key_value_tuples() :: [key_value_tuple()].
-type keys() :: [key()].
-type obj_type() :: list | map | atom().
-type object() :: list() | map() | any().
-type proplist() :: [{key(), value()}].
-type transform_list() :: [transform_tuple()].
-type transform_tuple() :: {update_action(), keys()}.
-type unmerged_object() :: object().
-type update_action() :: function() | updater_mod_fun() | updater_key().
-type updater_key() :: atom() | tuple().
-type updater_mod_fun() :: {atom(), atom()}.
-type value() :: any().
-type values() :: [value()].

Link to this section Functions

-spec delete(object(), key()) -> object().
Link to this function

delete_list(Obj, RestKeys)

View Source
-spec delete_list(object(), keys()) -> object().
-spec filter(object(), fun()) -> object().
-spec get(object(), key()) -> value().
-spec get(object(), key(), default_value()) -> value().
-spec get_list(object(), keys()) -> values().
Link to this function

get_list(Obj, Keys, Default)

View Source
-spec get_list(object(), keys(), default_value()) -> values().
-spec guess_merge([object()]) -> object().
-spec guess_merge(object(), object()) -> object().
-spec has_key(object(), key()) -> boolean().
-spec keep(object(), keys()) -> object().
-spec map(object(), fun()) -> object().
-spec merge([object()]) -> {object(), unmerged_object()}.
-spec merge(object(), object()) -> {object(), unmerged_object()}.
Link to this function

register_qdate_updaters()

View Source
Link to this function

register_type_handler(Module)

View Source
Link to this function

register_updater(UpdaterKey, MFA)

View Source
Link to this function

register_updaters(KeyMFAs)

View Source
-spec rekey(object(), key_map()) -> object().
Link to this function

rekey(Obj, FromKey, ToKey)

View Source
-spec rekey(object(), FromKey :: key(), ToKey :: key()) -> object().
-spec set(object(), key_value_tuple() | key_value_tuples() | object()) -> object().
-spec set(object(), key(), value()) -> object().
Link to this function

test_multiarg_updater(Exponent, Subtract, Val)

View Source
-spec to_list(object()) -> proplist().
-spec to_map(object()) -> map().
-spec to_type(obj_type(), object()) -> object().
-spec transform(object(), transform_list()) -> object().
-spec type(object()) -> obj_type().
Link to this function

unregister_qdate_updaters()

View Source
Link to this function

unregister_type_handler(Module)

View Source
Link to this function

unregister_updater(UpdaterKey)

View Source
Link to this function

unregister_updaters(Keys)

View Source
Link to this function

update(Obj, RestKeys, Updater)

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