package git

You can search for identifiers within the package.

in-package search v0.2.0

git
- Git
  - BASE
  - Blob
    
    Make
    
    Hash
    
    S
  - Commit
    
    Make
    
    Hash
    
    S
  - Cstruct_append
  - DIGEST
  - HASH
  - Hash
    
    Make
  - Mem
    
    Make
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
    
    Store
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
    
    Sync
    
    HTTP
    
    Store
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
  - Object_graph
    
    Make
    
    K
    
    E
    
    V
    
    Store
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
    
    S
    
    K
    
    E
    
    V
  - Reference
    
    Packed
    
    S
  - S
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
  - Search
    
    Make
    
    Store
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
  - Shallow
  - Store
    
    Make
    
    Hash
    
    Mj
    
    Mn
    
    Ref
    
    Reference
    
    Rs
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
    
    Mj
    
    Rs
  - Sync
    
    Make
    
    HTTP
    
    Index
    
    Pack
    
    Store
    
    Hash
    
    Ref
    
    Reference
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
    
    S
  - Tag
    
    Make
    
    Hash
    
    S
  - Traverse_bfs
    
    Make
    
    Store
    
    Hash
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
    
    STORE
    
    Hash
    
    Value
    
    Blob
    
    Commit
    
    Tag
    
    Tree
  - Tree
    
    Make
    
    Hash
    
    S
  - User
  - Value
    
    Make
    
    Blob
    
    Commit
    
    Hash
    
    Tag
    
    Tree
    
    S
    
    Blob
    
    Commit
    
    Tag
    
    Tree
git.loose
- Loose
  - Make
    
    Uid
  - UID
git.loose-git
- Loose_git
  - IO
  - Make
    
    IO
    
    Scheduler
    
    Store
    
    Uid
  - STORE
git.loose-lwt
- Loose_lwt
  - Make
    
    Uid
git.nss
- Nss
  - Fetch
    
    Make
    
    Flow
    
    IO
    
    Ref
    
    Scheduler
    
    Uid
  - Push
    
    Make
    
    Flow
    
    IO
    
    Ref
    
    Scheduler
    
    Uid
git.nss.git
- Smart_git
  - APPEND
  - Endpoint
  - HTTP
  - Make
    
    HTTP
    
    Index
    
    Pack
    
    Ref
    
    Scheduler
    
    Uid
  - UID
git.nss.hkt
- Hkt
  - Make_sched
    
    T
  - Make_store
    
    T
git.nss.neg
- Neg
git.nss.pck
- Pck
git.nss.pkt-line
- Pkt_line
  - Decoder
  - Encoder
git.nss.sigs
- Sigs
  - FLOW
  - IO
  - REF
  - SCHED
  - STORE
  - UID
git.nss.smart
- Smart
  - Advertised_refs
  - Capability
  - Commands
  - Context
  - Negotiation
  - Proto_request
  - Result
  - Shallow
  - Status
  - Want
git.nss.unixiz
- Unixiz
  - Make

Legend:
Library
Module
Module type
Parameter
Class
Class type

Module for decoding Git pkt lines, as specified at https://github.com/git/git/blob/master/Documentation/technical/protocol-common.txt

In the docs, we define min_pkt_len = 4 as in specs.

type decoder = {

buffer : bytes;
mutable pos : int;
mutable max : int;

}

val io_buffer_size : int

val create : unit -> decoder

val decoder_from : string -> decoder

val end_of_input : decoder -> int

type error = [

| `End_of_input
| `Expected_char of char
| `Unexpected_char of char
| `Expected_string of string
| `Expected_eol
| `Expected_eol_or_space
| `Unexpected_end_of_input
| `No_enough_space
| `Assert_predicate of char -> bool
| `Invalid_pkt_line

]

val pp_error : error Fmt.t

type 'err info = {

error : 'err;
buffer : bytes;
committed : int;

}

exception Leave of error info

type ('v, 'err) state =

| Done of 'v
| Read of {
1. buffer : bytes;
2. off : int;
3. len : int;
4. continue : int -> ('v, 'err) state;
5. eof : unit -> ('v, 'err) state;
}
| Error of 'err info

val leave_with : decoder -> error -> 'never

leave_with d error raises Leave { error; buffer = d.buffer; committed = d.pos }

raises Leave

val safe : 
  (decoder -> ('v, [> error ] as 'err) state) ->
  decoder ->
  ('v, 'err) state

safe k decoder wraps a call k decoder in a try-with block; if exception Leave err is raised, the function returns Error of err

val fail : decoder -> [> error ] as 'err -> ('v, 'err) state

val return : 'v -> decoder -> ('v, 'err) state

val peek_char : decoder -> char option

val string : string -> decoder -> unit

val junk_char : decoder -> unit

val while1 : (char -> bool) -> decoder -> bytes * int * int

returns
decoder.buffer, updated decoder.pos, # of bytes read

val at_least_one_pkt : decoder -> bool

returns true if decoder.max - decoder.pos is >= min_pkt_len and >= pkt_len, where pkt_len is the length of a pkt line starting at decoder.pos.

val at_least_one_line : decoder -> bool

val prompt : 
  ?strict:bool ->
  (decoder -> ('v, [> error ] as 'err) state) ->
  decoder ->
  ('v, 'err) state

val peek_while_eol : decoder -> bytes * int * int

val peek_while_eol_or_space : decoder -> bytes * int * int

val peek_pkt : decoder -> bytes * int * int

val junk_pkt : decoder -> unit

increase decoder.pos by max min_pkt_len pkt_len, where pkt_len is the length of the pkt line starting at the current value of decoder.pos (before increasing) and min_pkt_len = 4.

raises Invalid_argument
if there aren't 4 bytes representing the length