package carton-miou

  1. Overview
  2. Docs
Implementation of PACK file in OCaml for Miou

Install 

dune-project
 Dependency

git.robur.coop Readme Changelog MIT License Edit opam file Versions (2)

Authors

  1. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Maintainers

  1. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Sources

carton-1.3.0.tbz
sha256=0e709c06a5aeb2e6dea3282107167e143b9c22bc528ed75a8150067dbd8f957b
sha512=a1e2129b929f4dee96f8eabace173a57987a42657089135193a5f496088ba5e8fb2c620c4276a7385d2d97da4bbada5fb6790e230ade3b50df2d351bcde739a2

doc/carton-miou.unix/Carton_miou_unix/index.html

Module Carton_miou_unixSource

Sourcetype file_descr = Unix.file_descr * int
Sourceval map : file_descr -> pos:int -> int -> Bstr.t
Sourceval index : ?pagesize:int -> ?cachesize:int -> hash_length:int -> ref_length:int -> Fpath.t -> file_descr Classeur.t
Sourceval make : ?pagesize:int -> ?cachesize:int -> ?z:De.bigstring -> ref_length:int -> ?index:(Carton.Uid.t -> Carton.location) -> Fpath.t -> file_descr Carton.t
Sourcetype entry = {
  1. offset : int;
  2. crc : Optint.t;
  3. consumed : int;
  4. size : int;
}
Sourcetype config = {
  1. threads : int option;
  2. pagesize : int option;
  3. cachesize : int option;
  4. ref_length : int;
  5. identify : Carton.identify;
  6. on_entry : max:int -> entry -> unit;
  7. on_object : cursor:int -> Carton.Value.t -> Carton.Uid.t -> unit;
}
Sourceval config : ?threads:int -> ?pagesize:int -> ?cachesize:int -> ?on_entry:(max:int -> entry -> unit) -> ?on_object:(cursor:int -> Carton.Value.t -> Carton.Uid.t -> unit) -> ref_length:int -> Carton.identify -> config
Sourceval compile_on_seq : ?on:(max:int -> entry -> unit) -> identify:Carton.identify -> digest_length:int -> [ `Entry of Carton.First_pass.entry | `Hash of string | `Inflate of (Carton.Kind.t * int) option * string | `Number of int ] Seq.t -> Carton.oracle
Sourceval verify_from_pack : cfg:config -> digest:Carton.First_pass.digest -> Fpath.t -> Carton.status array * string
Sourceval verify_from_idx : cfg:config -> digest:Carton.First_pass.digest -> Fpath.t -> Carton.status array * string
Sourcemodule Window : sig ... end
Sourceval delta : ref_length:int -> load:(Carton.Uid.t -> 'meta -> Carton.Value.t) -> 'meta Cartonnage.Entry.t Seq.t -> 'meta Cartonnage.Target.t Seq.t
Sourceval to_pack : ?with_header:int -> ?with_signature:Carton.First_pass.digest -> ?cursor:int -> ?level:int -> load:(Carton.Uid.t -> 'meta -> Carton.Value.t) -> 'meta Cartonnage.Target.t Seq.t -> string Seq.t
Sourcetype delta = {
  1. source : Carton.Uid.t;
  2. depth : int;
  3. raw : Cachet.Bstr.t;
}
Sourceval entries_of_pack : cfg:config -> digest:Carton.First_pass.digest -> Fpath.t -> (file_descr Carton.t * delta option) Cartonnage.Entry.t array
Sourceval delta_from_pack : ref_length:int -> windows:('fd Carton.t * delta option) Window.t array -> ('fd Carton.t * delta option) Cartonnage.Entry.t Seq.t -> ('fd Carton.t * delta option) Cartonnage.Target.t Seq.t
Sourcetype sort = {
  1. sort : 'a. 'a Cartonnage.Entry.t array list -> int * 'a Cartonnage.Entry.t Seq.t;
}
Sourceval merge : cfg:config -> digest:Carton.First_pass.digest -> sort:sort -> ?level:int -> Fpath.t list -> string Seq.t
Sourceval delete_in_place : cfg:config -> digest:Carton.First_pass.digest -> pack:Fpath.t -> ?level:int -> Carton.Uid.t list -> unit

delete_in_place ~cfg ~digest ~pack uids modifies the PACK file pack in place. Entries whose UID is in uids, together with the old versions of their transitive delta-descendants, become ghost entries: their bytes remain in the file (so the PACK stays structurally parseable) but they are no longer referenced by the IDX. Fresh copies of every descendant are appended at the end of the PACK (direct children as bases, deeper descendants as carbon-copied deltas with recomputed ofs-delta headers). The header object count and trailer hash are updated accordingly. This operation does not reclaim disk space for the removed/replaced entries.