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
    
    H
    
    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
    
    Meta
    
    Option
    
    Write
  - Net
  - Store
    
    Deflate
    
    HDec
    
    IDec
    
    IEnc
    
    Inflate
    
    Loose
    
    D
    
    E
    
    Value
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Meta
    
    Option
    
    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
    
    Meta
    
    Option
  - Sync
    
    Endpoint
    
    G
    
    Deflate
    
    Hash
    
    Inflate
    
    Pack
    
    Ref
    
    Reference
    
    A
    
    D
    
    E
    
    M
    
    P
    
    Value
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Meta
    
    Option
    
    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
    
    Meta
    
    Option
    
    Map
    
    Set
    
    Commit
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Meta
    
    Option
    
    Map
    
    Set
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Meta
    
    Option
    
    Map
    
    Set
    
    Tag
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Meta
    
    Option
    
    Map
    
    Set
    
    Tree
    
    A
    
    D
    
    E
    
    M
    
    MakeMeta
    
    Meta
    
    Option
    
    Map
    
    Set

Legend:
Library
Module
Module type
Parameter
Class
Class type

type error =

| Invalid_header of string
(*
Appear when the header of the IDX file is incorrect.
*)
| Invalid_version of int32
(*
Appear when the version of the IDX file is wrong.
*)
| Invalid_index
(*
Appear when we try to read an area outside the IDX file.
*)
| Expected_bigoffset_table
(*
Appear when we try to read a big offset table and we can't catch it.
*)
| Invalid_bigoffset_index of int
(*
Appear when we try to read a big offset value and we can't catch it.
*)

The type error.

val pp_error : error Fmt.t

Pretty-printer of error.

type t

State of the IDX lzy decoder.

val make : ?cache:int -> Cstruct.t -> (t, error) Stdlib.result

Make a new state from a Cstruct.t buffer. You can specify how many elements we can store to the cache. This function returns the state t or an error.

Indeed, in this function we check if the IDX file stored entirely on the Cstruct.t is well-formed. Otherwise, we return an explicit error.

val find : t -> Hash.t -> (Checkseum.Crc32.t * int64) option

find t hash get the CRC-32 checksum and the absolute offset binded on hash in the IDX file represented by t only if hash exists. Otherwise, it returns None.

val mem : t -> Hash.t -> bool

mem t hash returns true if hash exists in the IDX file represented by t. Otherwise, it returns false.

val iter : t -> (Hash.t -> (Checkseum.Crc32.t * int64) -> unit) -> unit

Iteration in the IDX file.

val fold : t -> (Hash.t -> (Checkseum.Crc32.t * int64) -> 'a -> 'a) -> 'a -> 'a

Fold in the IDX file.

val cardinal : t -> int