View Source recon_rec (recon v2.5.6)
Link to this section Summary
Functions
remove all imported definitions, destroy the table, clean up
remove definitions imported from a module.
returns a list of active record definitions
import record definitions from a module. If a record definition of the same name and arity has already been imported from another module then the new definition is ignored (returned info tells you from which module the existing definition was imported). You have to choose one and possibly remove the old one using clear/1. Supports importing multiple modules at once (by giving a list of atoms as an argument).
quickly check if we want to do any record formatting
Limit output to selected fields of a record (can be 'none', 'all', a field or a list of fields). Limit set to 'none' means there is no limit, and all fields are displayed; limit 'all' means that all fields are squashed and only record name will be shown.
prints out all "known" (imported) record definitions and their limit settings. Printout tells module a record originates from, its name and a list of field names, plus the record's arity (may be handy if handling big records) and a list of field it limits its output to, if set.
Link to this section Types
-type field() :: atom().
-type import_result() :: {imported, module(), record_name(), arity()} | {overwritten, module(), record_name(), arity()} | {ignored, module(), record_name(), arity(), module()}.
-type listentry() :: {module(), record_name(), [field()], limit()}.
-type record_name() :: atom().
Link to this section Functions
-spec get_list() -> [listentry()].
-spec import(module() | [module()]) -> import_result() | [import_result()].
-spec is_active() -> boolean().
-spec limit(record_name(), arity(), limit()) -> ok | {error, any()}.