package mirage-kv

  1. Overview
  2. Docs
MirageOS signatures for key/value devices

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-kv-5.0.0.tbz
sha256=1036d74392461017ca8d9e32ccf94a5be6e03a056fa9ee551d4a7f49f6385462
sha512=f5acef8f8deedf5489e66fe5a088b468e1e691287f67563081564e3d66ad20c542dd600b3a0b118bc3d3d76bd91656ecb1fa31e9645fe9f6b224280a0876d939

doc/mirage-kv/Mirage_kv/index.html

Module Mirage_kvSource

MirageOS signatures for key/value devices

v5.0.0

Mirage_kv

MirageOS key-value stores are nested dictionaries, associating structured keys to either dictionaries or values.

Sourcemodule Key : sig ... end
Sourcetype key = Key.t

The type for keys.

Sourcetype error = [
  1. | `Not_found of key
    (*

    key not found

    *)
  2. | `Dictionary_expected of key
    (*

    key does not refer to a dictionary.

    *)
  3. | `Value_expected of key
    (*

    key does not refer to a value.

    *)
]

The type for errors.

Sourceval pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

Sourcemodule type RO = sig ... end
Sourcetype write_error = [
  1. | error
  2. | `No_space
    (*

    No space left on the device.

    *)
  3. | `Too_many_retries of int
    (*

    batch has been trying to commit n times without success.

    *)
]
Sourceval pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

Sourcemodule type RW = sig ... end
OCaml

Innovation. Community. Security.