package irmin-pack

You can search for identifiers within the package.

in-package search v0.2.0

Irmin backend which stores values in a pack file

Install

Dune Dependency

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

Authors

T

Thomas Gazagnaire

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.7.2.tbz

sha256=6aa5ba4c6a0233747d4bd3ab396f2b3a33bb80f9d8ed4a178c83a035033c0e52

sha512=8a5506a57e8569a11c883ca25b3c60ae7a9a03c2da111668193d7b4296434c43f1a310e78f189e4b38c234da790259d2961c6a0ae481282c18bb97f618fccfb6

doc/irmin-pack.unix/Irmin_pack_unix/Index/Make/index.html

Module `Index.Make`Source

An abstraction on top of the index library that exposes an API that better fits the irmin-pack use case.

Parameters

module K : Irmin.Hash.S

Signature

Sourcetype t

Sourcetype key = K.t

Sourcetype value = Optint.Int63.t * int * Irmin_pack.Pack_value.Kind.t

include Index.S with type value := value and type t := t and type key := key

Sourcetype cache

The type for caches of index instances.

Sourceval empty_cache : unit -> cache

Construct a new empty cache of index instances.

Sourceval clear : t -> unit

clear t clears t so that there are no more bindings in it.

Sourceval replace : ?overcommit:bool -> t -> key -> value -> unit

replace t k v binds k to v in t, replacing any existing binding of k.

If overcommit is true, the operation does not triger a merge, even if the caches are full. By default overcommit is false.

Sourceval sync : t -> unit

sync t syncs a read-only index with the files on disk. Raises RW_not_allowed if called by a read-write index.

Sourceval is_merging : t -> bool

is_merging t returns true if t is running a merge. Raises RO_not_allowed if called by a read-only index.

Sourcemodule Checks : sig ... end

Offline fsck-like utility for checking the integrity of Index stores built using this module.

Sourcemodule Io = Io.Unix

Source

val v_exn : 
  ?flush_callback:(unit -> unit) ->
  ?fresh:bool ->
  ?readonly:bool ->
  ?throttle:[ `Block_writes | `Overcommit_memory ] ->
  ?lru_size:int ->
  log_size:int ->
  string ->
  t

type create_error := [

| `Index_failure of string
| `Io_misc of Io.misc_error

]

type write_error := [

| `Index_failure of string
| `Io_misc of Io.misc_error
| `Ro_not_allowed

]

Source

val v : 
  ?flush_callback:(unit -> unit) ->
  ?fresh:bool ->
  ?readonly:bool ->
  ?throttle:[ `Block_writes | `Overcommit_memory ] ->
  ?lru_size:int ->
  log_size:int ->
  string ->
  (t, [> create_error ]) result

Sourceval reload : t -> (unit, [> write_error ]) result

Sourceval close : t -> (unit, [> write_error ]) result

Sourceval close_exn : t -> unit

Sourceval flush : t -> with_fsync:bool -> (unit, [> write_error ]) result

Sourceval find : t -> key -> value option

Sourceval add : ?overcommit:bool -> t -> key -> value -> unit

Sourceval merge : t -> unit

Sourceval mem : t -> key -> bool

Sourceval iter : (key -> value -> unit) -> t -> unit

Sourceval filter : t -> ((key * value) -> bool) -> unit

Sourceval try_merge : t -> unit

Sourcemodule Stats = Index.Stats

Sourcemodule Key : Index.Key.S with type t = key

On This Page

Parameters
Signature