package carton

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

First-pass of a PACK file.
Parameters
Signature

package carton

carton
- Library carton
  - Carton
    
    FUNCTOR
    
    SCHEDULER
    
    MUTEX
    
    CONDITION
    
    IO
    
    Mutex
    
    Condition
    
    Make
    
    UID
    
    Dec
    
    W
    
    Idx
    
    UID
    
    N
    
    Device
    
    M
    
    Fp
    
    Verify
    
    Ip
    
    Enc
    
    VERBOSE
    
    UID
    
    Delta
    
    N
- Library carton.thin
  - Thin
    
    Make
- Sources
  - carton
    
    carton.ml
    
    carton__.ml
    
    dec.ml
    
    enc.ml
    
    h.ml
    
    idx.ml
    
    sigs.ml
    
    zh.ml
  - carton.thin
    
    thin.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Dec.Fp`Source

First-pass of a PACK file.

From a stream, it is possible to infer information needed then to apply a second analyse to extract all objects of a the given PACK file. From Git, this pass appears when the client clone/fetch and the program counts how many objects the PACK file has.

  $ git clone ...
  remote: Enumerating objects: 105, done.
  remote: Counting objects: 100% (105/105), done.
  remote: Compressing objects: 100% (81/81), done.
  remote: Total 305 (delta 41), reused 75 (delta 23), pack-reused 200
  Receiving objects: 100% (305/305), 104.46 KiB | 0 bytes/s, done. # first pass

Parameters

module Uid : sig ... end

Signature

Sourcetype optint = Optint.t

Sourcetype kind =

| Base of [ `A | `B | `C | `D ]
| Ofs of {
1. sub : int;
2. source : weight;
3. target : weight;
}
| Ref of {
1. ptr : Uid.t;
2. source : weight;
3. target : weight;
}
(*
Type of PACK objects.
*)

Sourcetype entry = {

offset : int64;
(*
Absolute offset into the given PACK file.
*)
kind : kind;
(*
Kind of the object.
*)
size : weight;
(*
Length of the inflated object.
*)
consumed : int;
(*
Length of the deflated object (as it is into the PACK file).
*)
crc : optint;
(*
Check-sum of the entry (header plus the deflated object).
*)

}

Type of a PACK entry.

Source

val check_header : 
  's Carton__.Sigs.scheduler ->
  ('fd, 's) read ->
  'fd ->
  (int * string * int, 's) Carton__.Sigs.io

Sourcetype decoder

The type for decoders.

Sourcetype src = [

| `Channel of in_channel
| `String of string
| `Manual

]

The type for input sources. With a `Manual source the client must provide input with src.

Sourcetype decode = [

| `Await of decoder
| `Peek of decoder
| `Entry of entry * decoder
| `End of Uid.t
| `Malformed of string

]

Sourcetype header =

| Consumed of Bigstringaf.t
| None

Sourceval decoder : o:Bigstringaf.t -> allocate:(int -> De.window) -> src -> decoder

Sourceval decode : decoder -> decode

Sourceval number : decoder -> int

Sourceval version : decoder -> int

Sourceval count : decoder -> int

Sourceval ctx : decoder -> Uid.ctx

Sourceval src_rem : decoder -> int

Sourceval src : decoder -> Bigstringaf.t -> int -> int -> decoder

package carton

Module Dec.FpSource

First-pass of a PACK file.

Parameters

Signature

Module `Dec.Fp`Source