recon v2.5.3

View Source recon_map (recon v2.5.3)

This module handles formatting maps. It allows for trimming output to selected fields, or to nothing at all. It also adds a label to a printout. To set up a limit for a map, you need to give recon a way to tell the map you want to trim from all the other maps, so you have to provide something like a 'type definition'. It can be either another map which is compared to the arg, or a fun.

Link to this section Summary

Types

limit/0
map_label/0
pattern/0

Functions

clear()
remove all imported definitions, destroy the table, clean up
is_active()
quickly check if we want to do any record formatting
limit(Label, Pattern, Limit)

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).

list()
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)
remove a given map entry
rename(Name, NewName)
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.

Link to this section Types

Link to this type

limit/0

View Source 
-type limit() :: all | none | atom() | binary() | [any()].
Link to this type

map_label/0

View Source 
-type map_label() :: atom().
Link to this type

pattern/0

View Source 
-type pattern() :: map() | function().

Link to this section Functions

Link to this function

clear()

View Source
remove all imported definitions, destroy the table, clean up
Link to this function

is_active()

View Source 
-spec is_active() -> boolean().
quickly check if we want to do any record formatting
Link to this function

limit(Label, Pattern, Limit)

View Source 
-spec limit(map_label(), pattern(), 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.
Link to this function

list()

View Source
prints out all "known" map definitions and their limit settings. Printout tells a map's name, the matching fields required, and the limit options.
Link to this function

remove(Label)

View Source 
-spec remove(map_label()) -> true.
remove a given map entry
Link to this function

rename(Name, NewName)

View Source 
-spec rename(map_label(), 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.