package mirage-kv

  1. Overview
  2. Docs

Module Mirage_kv_lwtSource

  • deprecated This module will be removed from MirageOS 4.0. Please use Mirage_kv instead.
include module type of struct include Mirage_kv end

Mirage_kv

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

Sourcemodule Key = Mirage_kv.Key
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 = Mirage_kv.RO
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 = Mirage_kv.RW