package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Index.MakeSource

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
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
Sourceval 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 := [
  1. | `Index_failure of string
  2. | `Io_misc of Io.misc_error
]
type write_error := [
  1. | `Index_failure of string
  2. | `Io_misc of Io.misc_error
  3. | `Ro_not_allowed
]
Sourceval 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
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct