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 (1)

Authors

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

Maintainers

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

Sources

carton-1.2.0.tbz
sha256=7233406fc976184da8c1002f8a6d38beaf9a29968f8ce968d5175f39f777f594
sha512=9bd1cea6811e31ed8b7d1dc7b4ab2ddbe8f481402a340a3578c247c080d567f9cc97c164fd459c1c0a24cd9acb0852d99d70ba5fffef0ba6fac6af6d3e0ddbbc

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