package mmdb

You can search for identifiers within the package.

in-package search v0.2.0

package mmdb

mmdb
- CHANGES
- LICENSE
- README
- Library mmdb
  - Mmdb
    
    Common_error
    
    Open_file_error
    
    Fetch_ip_data_error
    
    Fetch_value_error
    
    Fetch_error
    
    Path
    
    Version_number
    
    Language
    
    Ip
    
    VALUE_TYPE
    
    Query
    
    Any
    
    Query
    
    String
    
    Query
    
    Float
    
    Query
    
    Int
    
    Query
    
    Bool
    
    Query
    
    Coordinates
    
    Query
- Library mmdb.ffi
  - Mmdb_ffi
    
    C
    
    Intptr
    
    Ptrdiff
    
    Uintptr
    
    CArray
    
    FOREIGN
    
    TYPE
    
    Root
    
    Core
    
    Helpers
- Library mmdb.types
  - Mmdb_types
    
    Mmdb
    
    Entry
    
    Lookup_result
    
    Entry_data
    
    Entry_data_type
    
    Mmdb_mode
    
    Error_code
- Library mmdb_ffi_bindings
  - Mmdb_ffi_bindings
    
    T
    
    M
    
    C
    
    Intptr
    
    Ptrdiff
    
    Uintptr
    
    CArray
    
    FOREIGN
    
    TYPE
    
    Root
    
    Core
    
    Helpers
- Library mmdb_types_bindings
  - Mmdb_types_bindings
    
    M
    
    Mmdb
    
    Entry
    
    Lookup_result
    
    Entry_data
    
    Entry_data_type
    
    Mmdb_mode
    
    Error_code
- Sources
  - mmdb
    
    coordinates.ml
    
    errors.ml
    
    mmdb.ml
    
    mmdb__.ml
    
    pointers.ml
    
    types.ml
  - mmdb.ffi
    
    g.ml
    
    mmdb_ffi.ml
    
    mmdb_ffi__.ml
  - mmdb.types
    
    g.ml
    
    mmdb_types.ml
    
    mmdb_types__.ml
  - mmdb_ffi_bindings
    
    mmdb_ffi_bindings.ml
  - mmdb_types_bindings
    
    mmdb_types_bindings.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Mmdb`Source

Binding to the maxminddb library which parses the MMDB format commonly known as GeoIP2

Sourcetype t

Reference to an MMBD file

Sourceexception Binding_integrity_error of string

Thrown when an error is detected that is an internal error of the library, not a usage error. It is recommended not to handle this, instead report a bug report in the library

Sourcemodule Common_error : sig ... end

Sourcemodule Open_file_error : sig ... end

Sourcemodule Fetch_ip_data_error : sig ... end

Sourcemodule Fetch_value_error : sig ... end

Sourcemodule Fetch_error : sig ... end

Sourceval library_version : string

The version string of the underlying C library

Sourcemodule Path : sig ... end

Sourceval open_file : Path.t -> (t, Open_file_error.t) result

Open an MMDB file and return a reference to it

Sourcemodule Version_number : sig ... end

Sourceval binary_format_version : t -> Version_number.t

The version number of the binary format in underlying MMDB file

Sourcemodule Language : sig ... end

Sourceval languages : t -> Language.t list

Retrieves a list of languages supported by the database

Sourceval language_by_code : t -> string -> Language.t option

Retrieves a specific language by its language code

Sourcemodule Ip : sig ... end

Sourcetype ip_data

An opaque reference to the data structure associated with an IP address

Sourceval fetch_ip_data : t -> Ip.t -> (ip_data, Fetch_ip_data_error.t) result

Retrieves the data associated with the supplied IP address

Sourcemodule type VALUE_TYPE = sig ... end

Signatures for handling queries that yield a particular type of answer

Sourcetype any_value =

| String of string
| Float of float
| Int of int
| Bool of bool

The supported atomic value types that can be retrieved from a database

Sourcemodule Any : VALUE_TYPE with type answer = any_value

Interface to query for values of type any_value. This may come useful in case the database contains different value types at the same query path. Specialized modules for retrieving strings, floats, integers and booleans are available below.

Sourcemodule String : sig ... end

Interface for retrieving string values from the database

Sourcemodule Float : VALUE_TYPE with type answer = float

Interface for retrieving float values from the database

Sourcemodule Int : VALUE_TYPE with type answer = int

Interface for retrieving integer values from the database

Sourcemodule Bool : VALUE_TYPE with type answer = bool

Interface for retrieving boolean values from the database

Sourcemodule Coordinates : sig ... end

Interface for retrieving coordinate values from the database

package mmdb

Module MmdbSource

Module `Mmdb`Source