The cl-maxminddb Reference Manual

Table of Contents

The cl-maxminddb Reference Manual

This is the cl-maxminddb Reference Manual, version 0.0.1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:25:31 2020 GMT+0.

1 Introduction

CL-MAXMINDDB

Description

CL-MAXMINDDB is MaxMind DB files reader.

Usage

> (with-mmdb (mmdb "/var/lib/GeoIP/GeoLite2-City.mmdb")
    (mmdb-query mmdb "8.8.8.8"))

(("continent" ("code" . "NA") ("geoname_id" . 6255149)
  ("names" ("de" . "Nordamerika") ("en" . "North America")
   ("es" . "Norteamérica") ("fr" . "Amérique du Nord") ("ja" . "北アメリカ")
   ("pt-BR" . "América do Norte") ("ru" . "Северная Америка")
   ("zh-CN" . "北美洲")))
 ("country" ("geoname_id" . 6252001) ("iso_code" . "US")
  ("names" ("de" . "USA") ("en" . "United States") ("es" . "Estados Unidos")
   ("fr" . "États-Unis") ("ja" . "アメリカ合衆国") ("pt-BR" . "Estados Unidos")
   ("ru" . "США") ("zh-CN" . "美国")))
 ("location" ("accuracy_radius" . 1000) ("latitude" . 37.751d0)
  ("longitude" . -97.822d0) ("time_zone" . "America/Chicago"))
 ("registered_country" ("geoname_id" . 6252001) ("iso_code" . "US")
  ("names" ("de" . "USA") ("en" . "United States") ("es" . "Estados Unidos")
   ("fr" . "États-Unis") ("ja" . "アメリカ合衆国") ("pt-BR" . "Estados Unidos")
   ("ru" . 

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-maxminddb

Author

Azamat S. Kalimoulline <turtle@bazon.ru>

License

GNU Lesser General Public License, v3

Description

CL MaxMind DB

Version

0.0.1.1

Dependencies

• babel
• cffi
• cffi-libffi
• ieee-floats
• iterate
• metabang-bind
• mmap

Source

cl-maxminddb.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-maxminddb/src

Parent

cl-maxminddb (system)

Location

src/

Components

• package.lisp (file)
• ip.lisp (file)
• maxminddb.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-maxminddb.asd

Location

cl-maxminddb.asd

Systems

cl-maxminddb (system)

4.1.2 cl-maxminddb/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

ru.bazon.cl-maxminddb

4.1.3 cl-maxminddb/src/ip.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/ip.lisp

Internal Definitions

• char->number (function)
• list->number (function)
• parse-ip (function)
• parse-ipv4 (function)
• parse-ipv6 (function)

4.1.4 cl-maxminddb/src/maxminddb.lisp

Dependencies

• package.lisp (file)
• ip.lisp (file)

Parent

src (module)

Location

src/maxminddb.lisp

Exported Definitions

• mmdb-query (function)
• with-mmdb (macro)

Internal Definitions

• *metadata-marker* (special variable)
• binary-128 (function)
• binary-32 (function)
• binary-list (function)
• copy-maxmind-database (function)
• copy-maxmind-database-metadata (function)
• find-ip-record (function)
• find-metadata-start (function)
• make-maxmind-database (function)
• make-maxmind-database-metadata (function)
• maxmind-database (structure)
• maxmind-database-filename (function)
• maxmind-database-metadata (function)
• (setf maxmind-database-metadata) (function)
• maxmind-database-metadata (structure)
• maxmind-database-metadata-binary-format-major-version (function)
• maxmind-database-metadata-binary-format-minor-version (function)
• maxmind-database-metadata-build-epoch (function)
• maxmind-database-metadata-database-type (function)
• maxmind-database-metadata-description (function)
• maxmind-database-metadata-ip-version (function)
• maxmind-database-metadata-languages (function)
• maxmind-database-metadata-node-count (function)
• maxmind-database-metadata-p (function)
• maxmind-database-metadata-record-size (function)
• maxmind-database-metadata-search-tree-size (function)
• maxmind-database-p (function)
• maxmind-database-ptr (function)
• maxmind-database-size (function)
• metadata-marker-p (function)
• mread-array (function)
• mread-boolean (function)
• mread-bytes (function)
• mread-data (function)
• mread-data-cache-container (function)
• mread-datafield-metadata (function)
• mread-double (function)
• mread-end-marker (function)
• mread-float (function)
• mread-int32 (function)
• mread-map (function)
• mread-mapentry (function)
• mread-node (function)
• mread-pointer (function)
• mread-raw-uchar (function)
• mread-raw-unsigned (function)
• mread-special-generic-length (function)
• mread-special-pointer-length (function)
• mread-uint128 (function)
• mread-uint16 (function)
• mread-uint32 (function)
• mread-uint64 (function)
• mread-unsigned (function)
• mread-utf8-string (function)
• read-metadata (function)

5 Packages

Packages are listed by definition order.

5.1 ru.bazon.cl-maxminddb

Source

package.lisp (file)

Nickname

cl-maxminddb

Use List

• mmap
• metabang.bind
• iterate
• ieee-floats
• common-lisp
• cffi
• babel

Exported Definitions

• mmdb-query (function)
• with-mmdb (macro)

Internal Definitions

• *metadata-marker* (special variable)
• binary-128 (function)
• binary-32 (function)
• binary-list (function)
• char->number (function)
• copy-maxmind-database (function)
• copy-maxmind-database-metadata (function)
• find-ip-record (function)
• find-metadata-start (function)
• list->number (function)
• make-maxmind-database (function)
• make-maxmind-database-metadata (function)
• maxmind-database (structure)
• maxmind-database-filename (function)
• maxmind-database-metadata (function)
• (setf maxmind-database-metadata) (function)
• maxmind-database-metadata (structure)
• maxmind-database-metadata-binary-format-major-version (function)
• maxmind-database-metadata-binary-format-minor-version (function)
• maxmind-database-metadata-build-epoch (function)
• maxmind-database-metadata-database-type (function)
• maxmind-database-metadata-description (function)
• maxmind-database-metadata-ip-version (function)
• maxmind-database-metadata-languages (function)
• maxmind-database-metadata-node-count (function)
• maxmind-database-metadata-p (function)
• maxmind-database-metadata-record-size (function)
• maxmind-database-metadata-search-tree-size (function)
• maxmind-database-p (function)
• maxmind-database-ptr (function)
• maxmind-database-size (function)
• metadata-marker-p (function)
• mread-array (function)
• mread-boolean (function)
• mread-bytes (function)
• mread-data (function)
• mread-data-cache-container (function)
• mread-datafield-metadata (function)
• mread-double (function)
• mread-end-marker (function)
• mread-float (function)
• mread-int32 (function)
• mread-map (function)
• mread-mapentry (function)
• mread-node (function)
• mread-pointer (function)
• mread-raw-uchar (function)
• mread-raw-unsigned (function)
• mread-special-generic-length (function)
• mread-special-pointer-length (function)
• mread-uint128 (function)
• mread-uint16 (function)
• mread-uint32 (function)
• mread-uint64 (function)
• mread-unsigned (function)
• mread-utf8-string (function)
• parse-ip (function)
• parse-ipv4 (function)
• parse-ipv6 (function)
• read-metadata (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Macros

Macro: with-mmdb (MMDB FILE) &body BODY

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

6.1.2 Functions

Function: mmdb-query MMDB IP-STRING

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *metadata-marker*

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

6.2.2 Functions

Function: binary-128 NUMBER

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: binary-32 NUMBER

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: binary-list NUMBER NUM-OF-BITS

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: char->number CHAR

Package

ru.bazon.cl-maxminddb

Source

ip.lisp (file)

Function: copy-maxmind-database INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: copy-maxmind-database-metadata INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: find-ip-record MMDB IP-BITS

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: find-metadata-start MMDB

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: list->number NLS RADIX TRANSFORMER

Package

ru.bazon.cl-maxminddb

Source

ip.lisp (file)

Function: make-maxmind-database &key (PTR PTR) (FILENAME FILENAME) (SIZE SIZE) (METADATA METADATA)

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: make-maxmind-database-metadata &key (NODE-COUNT NODE-COUNT) (RECORD-SIZE RECORD-SIZE) (IP-VERSION IP-VERSION) (DATABASE-TYPE DATABASE-TYPE) (LANGUAGES LANGUAGES) (BINARY-FORMAT-MAJOR-VERSION BINARY-FORMAT-MAJOR-VERSION) (BINARY-FORMAT-MINOR-VERSION BINARY-FORMAT-MINOR-VERSION) (BUILD-EPOCH BUILD-EPOCH) (DESCRIPTION DESCRIPTION) (SEARCH-TREE-SIZE SEARCH-TREE-SIZE)

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-filename INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata INSTANCE

Function: (setf maxmind-database-metadata) VALUE INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-binary-format-major-version INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-binary-format-minor-version INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-build-epoch INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-database-type INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-description INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-ip-version INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-languages INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-node-count INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-p OBJECT

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-record-size INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-metadata-search-tree-size INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-p OBJECT

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-ptr INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: maxmind-database-size INSTANCE

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: metadata-marker-p MMDB OFFSET

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-array MMDB DATA-START LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-boolean MMDB DATA-START LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-bytes MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-data MMDB OFFSET

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-data-cache-container MMDB DATA-START LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-datafield-metadata MMDB OFFSET

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-double MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-end-marker MMDB DATA-START LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-float MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-int32 MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-map MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-mapentry MMDB OFFSET

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-node MMDB NODE-NUMBER BIT

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-pointer MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-raw-uchar MMDB OFFSET

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-raw-unsigned MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-special-generic-length MMDB OFFSET LENGTH0

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-special-pointer-length MMDB OFFSET LENGTH0

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-uint128 MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-uint16 MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-uint32 MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-uint64 MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-unsigned MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: mread-utf8-string MMDB OFFSET LENGTH

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Function: parse-ip IP-ADDRESS

Package

ru.bazon.cl-maxminddb

Source

ip.lisp (file)

Function: parse-ipv4 IP-ADDRESS

Package

ru.bazon.cl-maxminddb

Source

ip.lisp (file)

Function: parse-ipv6 IP-ADDRESS

Package

ru.bazon.cl-maxminddb

Source

ip.lisp (file)

Function: read-metadata MMDB OFFSET

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

6.2.3 Structures

Structure: maxmind-database ()

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: ptr

Readers

maxmind-database-ptr (function)

Writers

(setf maxmind-database-ptr) (function)

Slot: filename

Readers

maxmind-database-filename (function)

Writers

(setf maxmind-database-filename) (function)

Slot: size

Initform

0

Readers

maxmind-database-size (function)

Writers

(setf maxmind-database-size) (function)

Slot: metadata

Readers

maxmind-database-metadata (function)

Writers

(setf maxmind-database-metadata) (function)

Structure: maxmind-database-metadata ()

Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: node-count

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-node-count (function)

Writers

(setf maxmind-database-metadata-node-count) (function)

Slot: record-size

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-record-size (function)

Writers

(setf maxmind-database-metadata-record-size) (function)

Slot: ip-version

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-ip-version (function)

Writers

(setf maxmind-database-metadata-ip-version) (function)

Slot: database-type

Type

string

Readers

maxmind-database-metadata-database-type (function)

Writers

(setf maxmind-database-metadata-database-type) (function)

Slot: languages

Type

vector

Readers

maxmind-database-metadata-languages (function)

Writers

(setf maxmind-database-metadata-languages) (function)

Slot: binary-format-major-version

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-binary-format-major-version (function)

Writers

(setf maxmind-database-metadata-binary-format-major-version) (function)

Slot: binary-format-minor-version

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-binary-format-minor-version (function)

Writers

(setf maxmind-database-metadata-binary-format-minor-version) (function)

Slot: build-epoch

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-build-epoch (function)

Writers

(setf maxmind-database-metadata-build-epoch) (function)

Slot: description

Type

list

Readers

maxmind-database-metadata-description (function)

Writers

(setf maxmind-database-metadata-description) (function)

Slot: search-tree-size

Type

fixnum

Initform

0

Readers

maxmind-database-metadata-search-tree-size (function)

Writers

(setf maxmind-database-metadata-search-tree-size) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types