View Source locus_mmdb_data_codec (locus v2.3.12)

API for working with MMDB - data codec

Summary

Types

index/0

Functions

parse_on_index(Index, DataSection, Raw)

Attempts to parse either the Value or RawValue (depending on the Raw flag) at Index in DataSection.

Types

index/0

-type index() :: non_neg_integer().

Functions

parse_on_index(Index, DataSection, Raw)

-spec parse_on_index(Index, DataSection, Raw) -> {Value | RawValue, RemainingData}
                  when
                      Index :: index(),
                      DataSection :: binary(),
                      Raw :: boolean(),
                      Value :: locus_mmdb_data:value(),
                      RawValue :: locus_mmdb_data_raw:value(),
                      RemainingData :: binary().

Attempts to parse either the Value or RawValue (depending on the Raw flag) at Index in DataSection.

Will crash upon invalid/unrecognized data, invalid pointers or cyclic pointer chasing (i.e. loops.)