package mirage-kv

  1. Overview
  2. Docs
On This Page
  1. Mirage_kv
MirageOS signatures for key/value devices

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (10)

Authors

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  2. S
    Stefanie Schirmer
  3. H
    Hannes Mehnert

Maintainers

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Sources

mirage-kv-6.1.1.tbz
sha256=7cd5cd95a0e96f9cd4036ad3c22e61d63e2fe0b426a2fc46f809babbed60b8f4
sha512=b62a726a6ff81251219cea678b97eb8ab552cb9184afc17871c0a42d370020cb837c6c269f8fb36c3398340c21f52077d84dac3d34baeefd8f3d2dc7e99842ae

doc/mirage-kv/Mirage_kv/index.html

Module Mirage_kvSource

MirageOS signatures for key/value devices

v6.1.1

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. | `Rename_source_prefix of key * key
    (*

    The source is a prefix of destination in rename.

    *)
  4. | `Already_present of key
    (*

    The key is already present.

    *)
]
Sourceval pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

Sourcemodule type RW = sig ... end