package irmin-unix

  1. Overview
  2. Docs
package irmin-unix
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module C : Irmin.Contents.S

Signature

include Irmin_git.S with type Backend.Remote.endpoint = Mimic.ctx * Smart_git.Endpoint.t with module Git = G with type Schema.Contents.t = C.t with type Schema.Metadata.t = Irmin_git.Metadata.t with type Schema.Info.t = Irmin.Info.default with type Schema.Path.step = string with type Schema.Path.t = string list with type Schema.Hash.t = G.hash with type Schema.Branch.t = Irmin_git.reference with type Backend.Remote.endpoint = endpoint
module Git = G
module Schema : sig ... end
type hash = Schema.Hash.t
type repo
type t
type step = Schema.Path.step
val step_t : step Irmin__.Type.t
type path = Schema.Path.t
val path_t : path Irmin__.Type.t
type metadata = Schema.Metadata.t
val metadata_t : metadata Irmin__.Type.t
type contents = Schema.Contents.t
val contents_t : contents Irmin__.Type.t
type node
val node_t : node Irmin__.Type.t
type tree
val tree_t : tree Irmin__.Type.t
val hash_t : hash Irmin__.Type.t
type commit
val commit_t : repo -> commit Irmin__.Type.t
type branch = Schema.Branch.t
val branch_t : branch Irmin__.Type.t
type slice
val slice_t : slice Irmin__.Type.t
type info = Schema.Info.t
val info_t : info Irmin__.Type.t
type lca_error = [
  1. | `Max_depth_reached
  2. | `Too_many_lcas
]
val lca_error_t : lca_error Irmin__.Type.t
type ff_error = [
  1. | `Max_depth_reached
  2. | `No_change
  3. | `Rejected
  4. | `Too_many_lcas
]
val ff_error_t : ff_error Irmin__.Type.t
module Info : sig ... end
type contents_key = hash
val contents_key_t : contents_key Irmin__.Type.t
type node_key = hash
val node_key_t : node_key Irmin__.Type.t
type commit_key = hash
val commit_key_t : commit_key Irmin__.Type.t
module Repo : sig ... end
val empty : repo -> t Lwt.t
val main : repo -> t Lwt.t
val of_branch : repo -> branch -> t Lwt.t
val of_commit : commit -> t Lwt.t
val repo : t -> repo
val tree : t -> tree Lwt.t
module Status : sig ... end
val status : t -> Status.t
module Head : sig ... end
module Hash : sig ... end
module Commit : sig ... end
module Contents : sig ... end
module Tree : sig ... end
val kind : t -> path -> [ `Contents | `Node ] option Lwt.t
val list : t -> path -> (step * tree) list Lwt.t
val mem : t -> path -> bool Lwt.t
val mem_tree : t -> path -> bool Lwt.t
val find_all : t -> path -> (contents * metadata) option Lwt.t
val find : t -> path -> contents option Lwt.t
val get_all : t -> path -> (contents * metadata) Lwt.t
val get : t -> path -> contents Lwt.t
val find_tree : t -> path -> tree option Lwt.t
val get_tree : t -> path -> tree Lwt.t
val key : t -> path -> [ `Contents of contents_key | `Node of node_key ] option Lwt.t
val hash : t -> path -> hash option Lwt.t
type write_error = [
  1. | `Conflict of string
  2. | `Test_was of tree option
  3. | `Too_many_retries of int
]
val write_error_t : write_error Irmin__.Type.t
val set : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> contents -> (unit, write_error) Stdlib.result Lwt.t
val set_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> contents -> unit Lwt.t
val set_tree : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> tree -> (unit, write_error) Stdlib.result Lwt.t
val set_tree_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> tree -> unit Lwt.t
val remove : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> (unit, write_error) Stdlib.result Lwt.t
val remove_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> unit Lwt.t
val test_and_set : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> test:contents option -> set:contents option -> (unit, write_error) Stdlib.result Lwt.t
val test_and_set_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> test:contents option -> set:contents option -> unit Lwt.t
val test_and_set_tree : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> test:tree option -> set:tree option -> (unit, write_error) Stdlib.result Lwt.t
val test_and_set_tree_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> t -> path -> test:tree option -> set:tree option -> unit Lwt.t
val merge : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> old:contents option -> t -> path -> contents option -> (unit, write_error) Stdlib.result Lwt.t
val merge_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> old:contents option -> t -> path -> contents option -> unit Lwt.t
val merge_tree : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> old:tree option -> t -> path -> tree option -> (unit, write_error) Stdlib.result Lwt.t
val merge_tree_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> info:Info.f -> old:tree option -> t -> path -> tree option -> unit Lwt.t
val with_tree : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> ?strategy:[ `Merge | `Set | `Test_and_set ] -> info:Info.f -> t -> path -> (tree option -> tree option Lwt.t) -> (unit, write_error) Stdlib.result Lwt.t
val with_tree_exn : ?retries:int -> ?allow_empty:bool -> ?parents:commit list -> ?strategy:[ `Merge | `Set | `Test_and_set ] -> info:Info.f -> t -> path -> (tree option -> tree option Lwt.t) -> unit Lwt.t
val clone : src:t -> dst:branch -> t Lwt.t
type watch
val watch : t -> ?init:commit -> (commit Irmin__.Diff.t -> unit Lwt.t) -> watch Lwt.t
val watch_key : t -> path -> ?init:commit -> ((commit * tree) Irmin__.Diff.t -> unit Lwt.t) -> watch Lwt.t
val unwatch : watch -> unit Lwt.t
type !'a merge = info:Info.f -> ?max_depth:int -> ?n:int -> 'a -> (unit, Irmin__.Merge.conflict) Stdlib.result Lwt.t
val merge_into : into:t -> t merge
val merge_with_branch : t -> branch merge
val merge_with_commit : t -> commit merge
val lcas : ?max_depth:int -> ?n:int -> t -> t -> (commit list, lca_error) Stdlib.result Lwt.t
val lcas_with_branch : t -> ?max_depth:int -> ?n:int -> branch -> (commit list, lca_error) Stdlib.result Lwt.t
val lcas_with_commit : t -> ?max_depth:int -> ?n:int -> commit -> (commit list, lca_error) Stdlib.result Lwt.t
module History : sig ... end
val history : ?depth:int -> ?min:commit list -> ?max:commit list -> t -> History.t Lwt.t
val last_modified : ?depth:int -> ?n:int -> t -> path -> commit list Lwt.t
module Branch : sig ... end
module Path : sig ... end
module Metadata : sig ... end
module Backend : sig ... end
type Irmin__.Remote.t +=
  1. | E of Backend.Remote.endpoint
val of_backend_node : repo -> Backend.Node.value -> node
val to_backend_node : node -> Backend.Node.value Lwt.t
val to_backend_portable_node : node -> Backend.Node_portable.t Lwt.t
val to_backend_commit : commit -> Backend.Commit.value
val of_backend_commit : repo -> Backend.Commit.Key.t -> Backend.Commit.value -> commit
val save_contents : [> Irmin__.Import.write ] Backend.Contents.t -> contents -> contents_key Lwt.t
val save_tree : ?clear:bool -> repo -> [> Irmin__.Import.write ] Backend.Contents.t -> [> Irmin__.Import.read_write ] Backend.Node.t -> tree -> [ `Contents of contents_key | `Node of node_key ] Lwt.t
val master : repo -> t Lwt.t
  • deprecated Use `main` instead.
val git_commit : Repo.t -> commit -> Git.Value.Commit.t option Lwt.t
val git_of_repo : Repo.t -> Git.t
val repo_of_git : ?head:Git.Reference.t -> ?bare:bool -> ?lock:Lwt_mutex.t -> Git.t -> Repo.t Lwt.t
val remote : ?ctx:Mimic.ctx -> ?headers:Cohttp.Header.t -> string -> Irmin.remote
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