Authors: bartlomiej.gorny@erlang-solutions.com
.
limit() = all | none | atom() | binary() | [any()]
map_label() = atom()
pattern() = map() | function()
clear/0 | remove all imported definitions, destroy the table, clean up. |
is_active/0 | quickly check if we want to do any record formatting. |
limit/3 | Limit output to selected keys of a map (can be 'none', 'all', a key or a list of keys). |
list/0 | prints out all "known" map definitions and their limit settings. |
remove/1 | remove a given map entry. |
rename/2 | rename a given map entry, which allows to to change priorities for matching. |
clear() -> any()
remove all imported definitions, destroy the table, clean up
is_active() -> boolean()
quickly check if we want to do any record formatting
limit(Label::map_label(), Pattern::pattern(), Limit::limit()) -> ok | {error, any()}
Limit output to selected keys of a map (can be 'none', 'all', a key or a list of keys). Pattern selects maps to process: a "pattern" is just a map, and if all key/value pairs of a pattern are present in a map (in other words, the pattern is a subset), then we say the map matches and we process it accordingly (apply the limit).
Patterns are applied in alphabetical order, until a match is found.
Instead of a pattern you can also provide a function which will take a map and return a boolean.list() -> any()
prints out all "known" map definitions and their limit settings. Printout tells a map's name, the matching fields required, and the limit options.
remove(Label::map_label()) -> true
remove a given map entry
rename(Name::map_label(), NewName::map_label()) -> renamed | missing
rename a given map entry, which allows to to change priorities for matching. The first argument is the current name, and the second argument is the new name.
Generated by EDoc