package git

  1. Overview
  2. Docs
On This Page
  1. Mimic values.
package git
Legend:
Library
Module
Module type
Parameter
Class
Class type
module type APPEND = sig ... end
module type UID = sig ... end
module type HTTP = sig ... end
module Endpoint : sig ... end

Mimic values.

When the user use an Endpoint.t to fetch or push, we fill the given Mimic's ctx with some available informations such as:

  • if we want to fetch (`Rd) or push (`Wr)
  • the scheme/protocol that the user would like to use (git://, SSH or HTTP - with or without TLS)
  • the path of the git repository
  • the host (an IP adress or a domain name)
  • the SSH user iff the user would like to use SSH
  • the port that the user would like to use

From this informations, the end-user can process them through the Mimic API (with Mimic.fold) and describe how to create needed values to start a protocol from them.

For example, if the user wants to use mirage-tcpip which needs an IP address and a port, he is able to re-use/map/fold git_host and git_port to craft what mirage-tcpip really needs.

Of course, such job is definitely outside the scope of ocaml-git and permits to us to be free about protocol implementations. An example of the plumbing needed is able with git-mirage which re-use these values to be able to start a mirage-tcpip connection, a awa-ssh connection of a cohttp (with or without ocaml-tls) connection.

val git_capabilities : [ `Rd | `Wr ] Mimic.value
val git_scheme : [ `Git | `SSH | `HTTP | `HTTPS | `Scheme of string ] Mimic.value
val git_path : string Mimic.value
val git_host : [ `Addr of Ipaddr.t | `Domain of [ `host ] Domain_name.t | `Name of string ] Mimic.value
val git_ssh_user : string Mimic.value
val git_port : int Mimic.value
module Make (Scheduler : Sigs.SCHED with type +'a s = 'a Lwt.t) (Pack : APPEND with type +'a fiber = 'a Lwt.t) (Index : APPEND with type +'a fiber = 'a Lwt.t) (HTTP : HTTP) (Uid : UID) (Ref : Sigs.REF) : 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