API Reference locus v2.3.7
Modules
The main API
Callbacks for providing your own database fetcher
Launches
locus_database_loader
and later shares the unpacked database, as well as any updates to it, through persistent_term
.Callback for implementing your own
locus_database
event subscribersLoads a file from the filesystem without blocking the caller
Stores a file in the filesystem without blocking the caller
Downloads a file using HTTP(S) without blocking the caller
Loads and unpacks databases while managing any associated assets (e.g. reading from and writing to cache)
Logging of
locus_database
events; can be adjusted in app config as well as at run time.Downloads an unpacked database edition from MaxMind, as well as its checksum (which it then verifies), without blocking the caller.
API for working with MMDB
API for working with MMDB - wholesomeness check
API for working with MMDB - data representation
API for working with MMDB - data codec
API for working with MMDB - raw data representation (it preserves the original type for when it's necessary to distinguish between e.g.
{uint32, 0}
and {uint16, 0}
, which locus_mmdb_data
does not allow for.)API for working with MMDB - metadata
API for working with MMDB - tree section