package git

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

Parameters

module Hash : sig ... end
module Mapper : sig ... end
module Inflate : sig ... end
module Hunk : H with module Hash := Hash
module Pack : P with module Hash := Hash and module Inflate := Inflate and module Hunk := Hunk

Signature

type error =
  1. | Invalid_hash of Hash.t
    (*

    Appears when the user requested a wrong hash.

    *)
  2. | Invalid_offset of int64
    (*

    Appears when the given offset is not available inside the PACK file.

    *)
  3. | Invalid_target of int * int
    (*

    Appears when the result of the application of a P.H.hunks returns a bad raw.

    *)
  4. | Unpack_error of Pack.t * Window.t * Pack.error
    (*

    Appears when we have an P.error.

    *)
  5. | Mapper_error of Mapper.error

The type error.

val pp_error : error Fmt.t

Pretty-printer for error.

type kind = [
  1. | `Commit
  2. | `Blob
  3. | `Tree
  4. | `Tag
]

The type of the kind of the git object.

type pack

The type of the decoder.

val idx : pack -> Hash.t -> (Checkseum.Crc32.t * int64) option
val extern : pack -> Hash.t -> (kind * Cstruct.t) option Lwt.t
val update_idx : (Hash.t -> (Checkseum.Crc32.t * int64) option) -> pack -> pack
val update_extern : (Hash.t -> (kind * Cstruct.t) option Lwt.t) -> pack -> pack
val make : ?bucket:int -> Mapper.fd -> (Hash.t -> (Checkseum.Crc32.t * int64) option) -> (Hash.t -> (kind * Cstruct.t) option Lwt.t) -> (pack, Mapper.error) result Lwt.t
module Diff : sig ... end
module Patch : sig ... end
module Base : sig ... end
module Object : sig ... end
module Cache : sig ... end
module Ascendant : sig ... end
module Descendant : sig ... end
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