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-v2.0.0.tbz
sha256=f2fee87fdc33e02826088347bd35782ab9cb842ac65933b06253413a61cdf53c
md5=ae3aed9d16c93fc67a429ea1b5727dca

doc/mirage-kv/Mirage_kv/index.html

Module Mirage_kv

MirageOS signatures for key/value devices

v2.0.0

Mirage_kv

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

module Key : sig ... end
type key = Key.t

The type for keys.

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

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

module type RO = sig ... end
type 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.

    *)
]
val pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

module type RW = sig ... end