• OCaml logo OCaml logo
  • Learn
  • Packages
  • Community
  • Blog
  • Playground
  • Searching...
    Or go to: Standard Library API
  • Learn
  • Packages
  • Community
  • Blog
  • Playground
  • Get started
  • git

  • Documentation
  • git lib
  • Git .Sync .Result Module
package git
  • git
    • Git
      • Blob
      • Commit
        • IO
          • D
      • FS
        • IO
        • Make
          • D
          • Digest
          • I
          • IO
          • Inflate
        • S
          • Digest
          • Inflate
      • Graph
        • K
          • E
          • V
        • Make
          • S
            • Digest
            • Inflate
      • Gri
      • Hash
        • Array
          • D
        • Blob
          • Map
          • Set
        • Commit
          • Map
          • Set
        • DIGEST
        • H
          • Map
          • Set
        • IO
          • Blob
            • Map
            • Set
          • Commit
            • Map
            • Set
          • D
          • Map
          • Set
          • Tree
            • Map
            • Set
        • Map
        • S
          • Map
          • Set
        • Set
        • Tree
          • Map
          • Set
      • IO
      • Index
        • IO
          • D
      • Inflate
        • M
        • Make
          • Z
        • None
        • S
        • ZLIB
      • Map
      • Mem
        • Make
          • D
          • Digest
          • I
          • Inflate
      • Object_type
      • Pack
        • IO
          • D
          • I
          • Raw
        • Raw
      • Pack_index
        • Make
          • D
          • Raw
        • Raw
      • Packed_refs
        • IO
          • D
      • Packed_value
        • IO
          • D
          • I
          • IO
          • V2
          • V3
        • PIC
      • Reference
        • Map
      • S
      • Search
        • Make
          • S
            • Digest
            • Inflate
      • Set
      • Store
        • S
          • Digest
          • Inflate
      • Sync
        • IO
        • Make
          • IO
          • S
            • Digest
            • Inflate
        • Result
        • S
      • Tag
        • IO
          • D
      • Tree
        • IO
          • D
      • User
      • Value
        • Cache
        • IO
          • D
          • I
  • git.top
    • Git_top
Legend:
Library
Module
Module type
Parameter
Class
Class type
type fetch

The resulting hashes and references.

val head_contents : fetch -> Reference.head_contents option

head_contents f is f's head contents (the value of the remote .git/HEAD).

val head : fetch -> Hash.Commit.t option

head f is f's head commit.

val references : fetch -> Hash.t Reference.Map.t

references f are f's references.

val hashes : fetch -> Hash.Set.t

hashes f are f's object hashes.

val pp_fetch : fetch Fmt.t

pp_fetch is the pretty-printer for fetch values.

type ok_or_error = [
  1. | `Ok
  2. | `Error of string
]
type push = {
  1. result : ok_or_error;
  2. commands : (Reference.t * ok_or_error) list;
}

The result of a push operation.

val pp_push : push Fmt.t

pp_push is the pretty-printer for push values.

Footer

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS

About Us

  • Industrial Users
  • Academic Users
  • Why OCaml

Resources

  • Get Started
  • Language Manual
  • Standard Library API
  • Books
  • Releases

Community

  • Blog
  • Jobs

Policies

  • Carbon Footprint
  • Governance
  • Privacy
  • Code of Conduct