package irmin

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Helper module containing useful top-level types for defining Irmin backends. This module is relatively unstable.

module Store_properties : sig ... end
module Logging : sig ... end

Logs tags attached to the log entries emitted by Irmin:

module Reversed_list : sig ... end

Reversed_list.t is constructed the same way as List.t, but needs to be reversed before it can be used as a regular list.

type read = Perms.read
type write = Perms.write
type read_write = Perms.read_write

Lwt syntax

include module type of struct include Lwt.Syntax end

Let syntax

Monadic syntax

val let* : 'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t

Syntax for bind.

val and* : 'a Lwt.t -> 'b Lwt.t -> ('a * 'b) Lwt.t

Syntax for both.

Applicative syntax

val let+ : 'a Lwt.t -> ('a -> 'b) -> 'b Lwt.t

Syntax for map.

val and+ : 'a Lwt.t -> 'b Lwt.t -> ('a * 'b) Lwt.t

Syntax for both.

val (>>=) : 'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t
val (>|=) : 'a Lwt.t -> ('a -> 'b) -> 'b Lwt.t

Dependency extensions

module Option : sig ... end
module List : sig ... end
module Seq : sig ... end
val shuffle : Stdlib.Random.State.t -> 'a array -> unit