package git

  1. Overview
  2. Docs
Git format and protocol in pure OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (8)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org
  2. R
    romain.calascibetta@gmail.com

Sources

git-3.16.1.tbz
sha256=c035bdcccd9e4d2f48c6d9cdc65e61fc10838ecf1d8a6f2a376ae20a8a924803
sha512=8173b5f64ad2e142aa6bd7a1c5b7d895a9e3fbf90b192d8021a32abb9430b62dd426d4b9b5856698fbae1a1bca2c30a22c270f6d361874c3d846533320ca51ea

doc/smart/Smart/index.html

Module SmartSource

Implementation of smart protocol.

This module does not have any Git logics. It provides a light implementation of the Smart protocol to be able to fetch/pull or push with a Git server.

Sourcemodule Capability : sig ... end

Capabilities module.

Sourcemodule Advertised_refs : sig ... end
Sourcemodule Proto_request : sig ... end
Sourcemodule Want : sig ... end
Sourcemodule Have : sig ... end
Sourcemodule Result : sig ... end
Sourcemodule Negotiation : sig ... end
Sourcemodule Commands : sig ... end
Sourcemodule Status : sig ... end
Sourcemodule Shallow : sig ... end
Sourcetype ('a, 'err) t =
  1. | Read of {
    1. buffer : bytes;
    2. off : int;
    3. len : int;
    4. k : int -> ('a, 'err) t;
    5. eof : unit -> ('a, 'err) t;
    }
  2. | Write of {
    1. buffer : string;
    2. off : int;
    3. len : int;
    4. k : int -> ('a, 'err) t;
    }
  3. | Return of 'a
  4. | Error of 'err
Sourcetype error = [
  1. | `End_of_input
  2. | `Expected_char of char
  3. | `Unexpected_char of char
  4. | `Expected_string of string
  5. | `Expected_eol
  6. | `Expected_eol_or_space
  7. | `Unexpected_end_of_input
  8. | `No_enough_space
  9. | `Assert_predicate of char -> bool
  10. | `Invalid_advertised_ref of string
  11. | `Invalid_shallow of string
  12. | `Invalid_negotiation_result of string
  13. | `Invalid_side_band of string
  14. | `Invalid_ack of string
  15. | `Invalid_result of string
  16. | `Invalid_command_result of string
  17. | `Invalid_command of string
  18. | `Invalid_want of string
  19. | `Invalid_have of string
  20. | `No_enough_space
  21. | `Unexpected_pkt_line of string
  22. | `Unexpected_flush
  23. | `Invalid_pkt_line of string
]
Sourceval pp_error : error Fmt.t
Sourcemodule Context : sig ... end
Sourcetype 'a send
Sourceval proto_request : Proto_request.t send
Sourceval send_want : (string, string) Want.t send
Sourceval negotiation_done : unit send
Sourceval flush : unit send
Sourceval commands : (string, string) Commands.t send
Sourceval send_pack : ?stateless:bool -> bool -> string send
Sourcetype 'a recv
Sourceval advertised_refs : (string, string) Advertised_refs.t recv
Sourceval negotiation_result : string Result.t recv
Sourceval recv_pack : ?push_stdout:(string -> unit) -> ?push_stderr:(string -> unit) -> bool -> [ `Payload of string * int * int | `End_of_transmission | `Stdout | `Stderr ] recv
Sourceval recv_flush : unit recv
Sourceval recv_commands : (string, string) Commands.t option recv
Sourceval send_acks : string Negotiation.t list send
Sourceval recv_ack : string Negotiation.t recv
Sourceval shallows : string Shallow.t list recv
Sourceval status : bool -> string Status.t recv
Sourceval packet : trim:bool -> string recv
Sourceval send_advertised_refs : (string, string) Advertised_refs.t send
Sourceval recv_want : (string, string) Want.t option recv
Sourceval recv_have : string Have.t recv
Sourceval bind : ('a, 'err) t -> f:('a -> ('b, 'err) t) -> ('b, 'err) t
Sourceval (let*) : ('a, 'err) t -> ('a -> ('b, 'err) t) -> ('b, 'err) t
Sourceval (>>=) : ('a, 'err) t -> ('a -> ('b, 'err) t) -> ('b, 'err) t
Sourceval encode : Context.t -> 'a send -> 'a -> (Context.t -> ('b, [> `Protocol of error ] as 'err) t) -> ('b, 'err) t
Sourceval decode : Context.t -> 'a recv -> (Context.t -> 'a -> ('b, [> `Protocol of error ] as 'err) t) -> ('b, 'err) t
Sourceval send : Context.t -> 'a send -> 'a -> (unit, [> `Protocol of error ]) t
Sourceval recv : Context.t -> 'a recv -> ('a, [> `Protocol of error ]) t
Sourceval return : 'v -> ('v, 'err) t
Sourceval fail : 'err -> ('v, 'err) t
Sourceval reword_error : ('err0 -> 'err1) -> ('v, 'err0) t -> ('v, 'err1) t
Sourceval error_msgf : ('a, Stdlib.Format.formatter, unit, ('b, [> `Msg of string ]) t) Stdlib.format4 -> 'a