The cl-maxminddb Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

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 Fri Jun 26 10:22:18 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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" . 

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

cl-maxminddb.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 cl-maxminddb/src

Parent

cl-maxminddb (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-maxminddb.asd

Location

cl-maxminddb.asd

Systems

cl-maxminddb (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-maxminddb/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

ru.bazon.cl-maxminddb


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-maxminddb/src/ip.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/ip.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-maxminddb/src/maxminddb.lisp

Dependencies
Parent

src (module)

Location

src/maxminddb.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 ru.bazon.cl-maxminddb

Source

package.lisp (file)

Nickname

cl-maxminddb

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

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

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: mmdb-query MMDB IP-STRING
Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *metadata-marker*
Package

ru.bazon.cl-maxminddb

Source

maxminddb.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-maxminddb.asd: The cl-maxminddb․asd file
cl-maxminddb/src: The cl-maxminddb/src module
cl-maxminddb/src/ip.lisp: The cl-maxminddb/src/ip․lisp file
cl-maxminddb/src/maxminddb.lisp: The cl-maxminddb/src/maxminddb․lisp file
cl-maxminddb/src/package.lisp: The cl-maxminddb/src/package․lisp file

F
File, Lisp, cl-maxminddb.asd: The cl-maxminddb․asd file
File, Lisp, cl-maxminddb/src/ip.lisp: The cl-maxminddb/src/ip․lisp file
File, Lisp, cl-maxminddb/src/maxminddb.lisp: The cl-maxminddb/src/maxminddb․lisp file
File, Lisp, cl-maxminddb/src/package.lisp: The cl-maxminddb/src/package․lisp file

L
Lisp File, cl-maxminddb.asd: The cl-maxminddb․asd file
Lisp File, cl-maxminddb/src/ip.lisp: The cl-maxminddb/src/ip․lisp file
Lisp File, cl-maxminddb/src/maxminddb.lisp: The cl-maxminddb/src/maxminddb․lisp file
Lisp File, cl-maxminddb/src/package.lisp: The cl-maxminddb/src/package․lisp file

M
Module, cl-maxminddb/src: The cl-maxminddb/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   C   F   L   M   P   R   W  
Index Entry  Section

(
(setf maxmind-database-metadata): Internal functions

B
binary-128: Internal functions
binary-32: Internal functions
binary-list: Internal functions

C
char->number: Internal functions
copy-maxmind-database: Internal functions
copy-maxmind-database-metadata: Internal functions

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

L
list->number: Internal functions

M
Macro, with-mmdb: Exported macros
make-maxmind-database: Internal functions
make-maxmind-database-metadata: Internal functions
maxmind-database-filename: Internal functions
maxmind-database-metadata: Internal functions
maxmind-database-metadata-binary-format-major-version: Internal functions
maxmind-database-metadata-binary-format-minor-version: Internal functions
maxmind-database-metadata-build-epoch: Internal functions
maxmind-database-metadata-database-type: Internal functions
maxmind-database-metadata-description: Internal functions
maxmind-database-metadata-ip-version: Internal functions
maxmind-database-metadata-languages: Internal functions
maxmind-database-metadata-node-count: Internal functions
maxmind-database-metadata-p: Internal functions
maxmind-database-metadata-record-size: Internal functions
maxmind-database-metadata-search-tree-size: Internal functions
maxmind-database-p: Internal functions
maxmind-database-ptr: Internal functions
maxmind-database-size: Internal functions
metadata-marker-p: Internal functions
mmdb-query: Exported functions
mread-array: Internal functions
mread-boolean: Internal functions
mread-bytes: Internal functions
mread-data: Internal functions
mread-data-cache-container: Internal functions
mread-datafield-metadata: Internal functions
mread-double: Internal functions
mread-end-marker: Internal functions
mread-float: Internal functions
mread-int32: Internal functions
mread-map: Internal functions
mread-mapentry: Internal functions
mread-node: Internal functions
mread-pointer: Internal functions
mread-raw-uchar: Internal functions
mread-raw-unsigned: Internal functions
mread-special-generic-length: Internal functions
mread-special-pointer-length: Internal functions
mread-uint128: Internal functions
mread-uint16: Internal functions
mread-uint32: Internal functions
mread-uint64: Internal functions
mread-unsigned: Internal functions
mread-utf8-string: Internal functions

P
parse-ip: Internal functions
parse-ipv4: Internal functions
parse-ipv6: Internal functions

R
read-metadata: Internal functions

W
with-mmdb: Exported macros

Jump to:   (  
B   C   F   L   M   P   R   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
B   D   F   I   L   M   N   P   R   S  
Index Entry  Section

*
*metadata-marker*: Internal special variables

B
binary-format-major-version: Internal structures
binary-format-minor-version: Internal structures
build-epoch: Internal structures

D
database-type: Internal structures
description: Internal structures

F
filename: Internal structures

I
ip-version: Internal structures

L
languages: Internal structures

M
metadata: Internal structures

N
node-count: Internal structures

P
ptr: Internal structures

R
record-size: Internal structures

S
search-tree-size: Internal structures
size: Internal structures
Slot, binary-format-major-version: Internal structures
Slot, binary-format-minor-version: Internal structures
Slot, build-epoch: Internal structures
Slot, database-type: Internal structures
Slot, description: Internal structures
Slot, filename: Internal structures
Slot, ip-version: Internal structures
Slot, languages: Internal structures
Slot, metadata: Internal structures
Slot, node-count: Internal structures
Slot, ptr: Internal structures
Slot, record-size: Internal structures
Slot, search-tree-size: Internal structures
Slot, size: Internal structures
Special Variable, *metadata-marker*: Internal special variables

Jump to:   *  
B   D   F   I   L   M   N   P   R   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   M   P   R   S  
Index Entry  Section

C
cl-maxminddb: The cl-maxminddb system

M
maxmind-database: Internal structures
maxmind-database-metadata: Internal structures

P
Package, ru.bazon.cl-maxminddb: The ru․bazon․cl-maxminddb package

R
ru.bazon.cl-maxminddb: The ru․bazon․cl-maxminddb package

S
Structure, maxmind-database: Internal structures
Structure, maxmind-database-metadata: Internal structures
System, cl-maxminddb: The cl-maxminddb system

Jump to:   C   M   P   R   S