View Source locus_mmdb_check (locus v2.3.6)

API for working with MMDB - wholesomeness check

Link to this section Summary

Functions

Checks for errors and quirks within Database

Link to this section Types

Link to this type

bad_chunk_in_data_section/0

View Source

Specs

bad_chunk_in_data_section() ::
    {bad_chunk_in_data_section,
     #{position := non_neg_integer(),
       why := term(),
       under := #{path := [{non_neg_integer(), term()}]}}}.
Link to this type

bad_data_index_in_tree/0

View Source

Specs

bad_data_index_in_tree() ::
    {bad_data_index_in_tree,
     non_neg_integer(),
     #{why := term(), under := #{prefix := string(), path := [non_neg_integer()]}}}.
Link to this type

bad_node_index_in_tree/0

View Source

Specs

bad_node_index_in_tree() ::
    {bad_node_index_in_tree,
     non_neg_integer(),
     #{under := #{prefix := string(), path := [non_neg_integer()]}}}.

Specs

Link to this type

excessively_long_path_in_tree/0

View Source

Specs

excessively_long_path_in_tree() ::
    {excessively_long_path_in_tree,
     non_neg_integer(),
     #{under := #{prefix := string(), path := [non_neg_integer()]}}}.
Link to this type

invalid_position_in_data_section/0

View Source

Specs

invalid_position_in_data_section() ::
    {invalid_position_in_data_section,
     #{which => non_neg_integer(), under := #{path := [{non_neg_integer(), term()}]}}}.
Link to this type

invalid_utf8_string_in_data_section/0

View Source

Specs

invalid_utf8_string_in_data_section() ::
    {invalid_utf8_string_in_data_section,
     #{position := non_neg_integer(),
       original_data := binary(),
       error := term(),
       under := #{path := [{non_neg_integer(), term()}]}}}.
Link to this type

loop_in_data_section/0

View Source

Specs

loop_in_data_section() :: {loop_in_data_section, #{path => [{non_neg_integer(), term()}, ...]}}.
Link to this type

map_key_of_wrong_type_in_data_section/0

View Source

Specs

map_key_of_wrong_type_in_data_section() ::
    {map_key_of_wrong_type_in_data_section,
     #{position := non_neg_integer(),
       key := term(),
       under := #{path := [{non_neg_integer(), term()}]}}}.
Link to this type

unprintable_utf8_string_in_data_section/0

View Source

Specs

unprintable_utf8_string_in_data_section() ::
    {unprintable_utf8_string_in_data_section,
     #{position := non_neg_integer(),
       value := unicode:unicode_binary(),
       under := #{path := [{non_neg_integer(), term()}]}}}.

Specs

Link to this section Functions

Specs

run(locus_mmdb:database()) ->
       ok | {warnings, [warning(), ...]} | {errors, [error(), ...], [warning()]}.
Checks for errors and quirks within Database