package git-unix

You can search for identifiers within the package.

in-package search v0.2.0

package git-unix

git-unix
- Git_unix
  - Fs
    
    Dir
    
    File
    
    Mapper
  - Index
    
    ENTRY
    
    Entry
    
    Make
    
    Entry
    
    FS
    
    Dir
    
    File
    
    Mapper
    
    Read
    
    Snapshot
    
    Store
    
    Deflate
    
    Hash
    
    Inflate
    
    Pack
    
    Ref
    
    Reference
    
    A
    
    D
    
    E
    
    M
    
    P
    
    Value
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Write
  - Net
  - Store
    
    Deflate
    
    HDec
    
    IDec
    
    IEnc
    
    Inflate
    
    Loose
    
    D
    
    E
    
    Value
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    PDec
    
    PEnc
    
    Delta
    
    Entry
    
    Hunk
    
    PInfo
    
    Pack
    
    Deflate
    
    IDec
    
    IEnc
    
    PEnc
    
    Delta
    
    Entry
    
    Hunk
    
    PInfo
    
    Packed_refs
    
    A
    
    D
    
    E
    
    M
    
    RPDec
    
    Ascendant
    
    Base
    
    Cache
    
    Descendant
    
    Diff
    
    Object
    
    Patch
    
    Ref
    
    Reference
    
    A
    
    D
    
    E
    
    M
    
    P
    
    Value
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
  - Sync
    
    Endpoint
    
    G
    
    Deflate
    
    Hash
    
    Inflate
    
    Pack
    
    Ref
    
    Reference
    
    A
    
    D
    
    E
    
    M
    
    P
    
    Value
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Http
    
    Client
    
    Endpoint
    
    Web
    
    HTTP
    
    Headers
    
    Request
    
    Response
    
    Tcp
    
    Endpoint
git-unix.top
- Git_top
  - Graph
    
    K
    
    E
    
    V
    
    Store
    
    Deflate
    
    Hash
    
    Map
    
    Set
    
    Inflate
    
    Pack
    
    Ref
    
    Reference
    
    A
    
    D
    
    E
    
    M
    
    Map
    
    P
    
    Set
    
    Value
    
    A
    
    Blob
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Map
    
    Set
    
    Commit
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Map
    
    Set
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Map
    
    Set
    
    Tag
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Map
    
    Set
    
    Tree
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Map
    
    Set

Legend:
Library
Module
Module type
Parameter
Class
Class type

val mem : t -> Reference.t -> bool Lwt.t

mem state ref is true iff ref exists in state, otherwise it is false.

val graph : t -> (Hash.t Reference.Map.t, error) Stdlib.result Lwt.t

graph state is the graph containing all the references and their relationship in the current git repository state.

val normalize : 
  Hash.t Reference.Map.t ->
  Reference.head_contents ->
  (Hash.t, error) Stdlib.result Lwt.t

normalize graph ref is the final hash pointed by the reference ref. This function can return an error:

`Invalid_reference ref if, from the graph graph, we don't find the final pointed hash. This case can appear if the graph is not complete or if the link is broken.

val list : t -> (Reference.t * Hash.t) list Lwt.t

list state is the list of references and their associated hash. This function is the same than:

> graph state >|= Reference.Map.fold (fun x acc -> x :: acc)

Finally, as for graph, if we encountered any error, we make it silent and continue the process.

val remove : t -> Reference.t -> (unit, error) Stdlib.result Lwt.t

remove state reference removes the reference reference from the git repository state.

val read : 
  t ->
  Reference.t ->
  (Reference.head_contents, error) Stdlib.result Lwt.t

read state reference is the value contained in the reference reference (available in the git repository state).

val resolve : t -> Reference.t -> (Hash.t, error) Stdlib.result Lwt.t

val write : 
  t ->
  Reference.t ->
  Reference.head_contents ->
  (unit, error) Stdlib.result Lwt.t

write state reference value writes the value value in the the reference in the git repository state.