DataKit is a concrete implementation of an Irmin store. It also allow to expose such store as a VFS directory.
module Hash : Irmin.Hash.S with type t = Irmin.Hash.SHA1.tHash is SHA1.
module Path : Irmin.Path.S with type step = stringPath are list of strings, with constant-time rdecons operations (e.g. to have efficient basename/dirname split).
module Metadata : Irmin.Metadata.S with type t = [ `Normal | `Exec | `Link ]Metadata are similar to Git metadata.
module Branch : Irmin.Branch.S with type t = stringBranch are ASCII strings where '/' is also allowed.
module Blob : sig ... endBlob are lists of cstructs, with constant-time append operations. This is optimized to store large files where contents is always appended (e.g. log files).
type hash = Hash.tThe type for SHA1 hashes.
type path = Path.tThe type for store paths
type step = Path.stepThe type for store steps.
type perm = Metadata.tThe type for file permissions.
type branch = Branch.tThe type for branch names.
type blob = Blob.tThe type for blob contents.
module type S =
Irmin.S
with type key = path
and type contents = blob
and type branch = string
and type step = step
and type metadata = perm
and type Commit.Hash.t = hash
and type Tree.Hash.t = hash
and type Contents.Hash.t = hashThe type for DataKit stores. Similar to Irmin_git.S but with specialized contents (optimized for append-operations), paths and branches.
module Make (M : Irmin.S_MAKER) : SMake an DataKit store from a normal Irmin backend.
module type GIT_S_MAKER =
functor (C : Irmin.Contents.S) ->
functor (P : Irmin.Path.S) ->
functor (B : Irmin.Branch.S) ->
Irmin.S
with type key = P.t
and type step = P.step
and module Key = P
and type contents = C.t
and type branch = B.t
and type metadata = perm
and type Commit.Hash.t = hash
and type Tree.Hash.t = hash
and type Contents.Hash.t = hashSimilar to Irmin_git.S_MAKER
module Make_git (M : GIT_S_MAKER) : SMake a DataKit store from a Git-like Irmin backend.
module type VFS = sig ... endThe signature of an Irmin VFS servers.