package git

  1. Overview
  2. Docs
package git
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Value.MakeSource

The functor to make the OCaml representation of the Git object by a specific hash implementation, an S.INFLATE implementation for the decompression and a S.DEFLATE implementation for the compression.

The constraints on git objects can cut the path to let the user to make the value module and keep the structural equality. If the Hash module is the same. That means:

```ocaml module V1 = Value.Make(SHA1)(C_inflate)(C_deflate) module V2 = Value.Make(SHA1)(OCaml_inflate)(OCaml_deflate) ```

Types V1.t and V2.t are equal.

Parameters

module Hash : sig ... end

Signature

Sourcetype hash = Hash.t
Sourcetype nonrec t = hash t

OCaml value which represents a Git object.

Sourcemodule Blob : Blob.S with type hash = hash
Sourcemodule Commit : Commit.S with type hash = hash
Sourcemodule Tree : Tree.S with type hash = hash
Sourcemodule Tag : Tag.S with type hash = hash
Sourceval blob : Blob.t -> t
Sourceval commit : Commit.t -> t
Sourceval tree : Tree.t -> t
Sourceval tag : Tag.t -> t
Sourceval kind : t -> [ `Commit | `Blob | `Tree | `Tag ]

kind o returns the kind of the Git object.

Sourceval format : t Encore.t
Sourceval digest : t -> hash

digest t associates a hash to any value of t. It is guaranteed that if x = y or compare x y = 0, then digest x = digest y.

Sourceval pp : t Fmt.t

Pretty-printer of t.

Sourceval compare : t -> t -> int

The comparison function for t.

Sourceval hash : t -> int

hash blob associates a non-negative integer to any value of t. It is guaranteed that if x = y or compare x y = 0, then hash x = hash y.

Sourceval equal : t -> t -> bool

The equal function for t.

Sets and Maps.

Sourcemodule Set : Set.S with type elt = t
Sourcemodule Map : Map.S with type key = t
Sourceval length : t -> int64
Sourceval to_raw : t -> string
Sourceval to_raw_without_header : t -> string
Sourceval of_raw_with_header : ?off:int -> ?len:int -> string -> (t, [> `Msg of string ]) result
Sourceval of_raw : kind:[ `Commit | `Blob | `Tree | `Tag ] -> Cstruct.t -> (t, [> `Msg of string ]) result
Sourceval stream : t -> unit -> string option Lwt.t
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