package decompress

You can search for identifiers within the package.

in-package search v0.2.0

decompress
- Decompress
  - Buffer
    
    Bigstring
  - DEFLATE
    
    F
  - Gzip_deflate
    
    F
  - Gzip_inflate
  - Hunk
  - INFLATE
  - Lz77
  - OS
  - RFC1951_deflate
    
    F
  - RFC1951_inflate
  - Window
  - Zlib_deflate
    
    F
  - Zlib_inflate
decompress.impl
- Impl
  - Decompress_bigstring
  - Decompress_buffer
  - Decompress_bytes
  - Decompress_deflate
    
    Convenience
    
    X
    
    DEFLATE
    
    F
    
    Gzip
    
    KCrc32
    
    KHeader
    
    KSize
    
    RFC1951
    
    F
    
    KDynamicHeader
    
    KWriteBlock
    
    S
    
    Zlib
    
    KAdler32
    
    KHeader
  - Decompress_heap
  - Decompress_hunk
  - Decompress_inflate
    
    Convenience
    
    X
    
    Gzip
    
    KCrc
    
    KHeader
    
    KSize
    
    INFLATE
    
    RFC1951
    
    Dictionary
    
    Heap
    
    Huffman
    
    KBlock
    
    KDictionary
    
    KFlat
    
    KInflate
    
    KLast
    
    Lookup
    
    S
    
    Zlib
    
    KCrc
    
    KHeader
  - Decompress_lz77
    
    T
  - Decompress_option
  - Decompress_os
  - Decompress_q
  - Decompress_safe
  - Decompress_seq
  - Decompress_tables
  - Decompress_tree
  - Decompress_window
    
    Crc

Legend:
Library
Module
Module type
Parameter
Class
Class type

Window used by the Inflate algorithm.

A functionnal implementation of window to use with the inflate algorithm. After one process, you can reset and reuse the window for a new process. This API is available to limit the allocation by Decompress.

type ('o, 'k) t

The Window specialized by 'o (see Buffer.bytes and Buffer.bigstring).

type 'k checksum

type adler32

type crc32

type none

val adler32 : adler32 checksum

Adler-32 algorithm.

val crc32 : crc32 checksum

CRC-32 algorithm.

val none : none checksum

Avoid checksum computation (no algorithm).

val create : crc:'k checksum -> witness:'o Buffer.t -> ('o, 'k) t

create ~crc ~witness creates a new window with a specific crc algorithm (see adler32, crc32 and none).

val reset : ('o, 'k) t -> ('o, 'k) t

reset window resets a window to be reused by an Inflate algorithm.

val crc : ('o, 'k) t -> Optint.t

crc window returns the checksum computed by the window.