DeepDive.Comparer (Deep Dive v1.0.0) View Source

This module holds the logic to match the keys in a data structure.

Link to this section Summary

A fuzzy_matcher is one that may return upon match more than one result.

A matcher is any type that may be compared to a key. There are two special cases

This function retrieves all the matches of matcher. The return value is a list of the key-value tuples.

This function retrieves the first match of matcher and the corresponting matching key. In case of no match, it returns nil.

fuzzy_matcher() :: Regex.t() | (term() -> bool())

A fuzzy_matcher is one that may return upon match more than one result.

matcher() ::
  char()
  | String.t()
  | atom()
  | list()
  | map()
  | struct()
  | pid()
  | fuzzy_matcher()

A matcher is any type that may be compared to a key. There are two special cases:

get_all_keys(map(), matcher()) :: DeepDive.result()

This function retrieves all the matches of matcher. The return value is a list of the key-value tuples.

Note also that this function operates only at the first level and does not steps into the key values.

get_key(map(), matcher()) :: {term(), term()} | nil

This function retrieves the first match of matcher and the corresponting matching key. In case of no match, it returns nil.