package decompress

  1. Overview
  2. Docs

Source file decompress.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
module B = Decompress_impl.B
module Hunk = Decompress_impl.Hunk
module L = Decompress_impl.L

module type DEFLATE = sig
  type error

  module F : sig
    type t = int array * int array
  end

  type ('i, 'o) t

  val pp_error : Format.formatter -> error -> unit
  val pp : Format.formatter -> ('i, 'o) t -> unit
  val get_frequencies : ('i, 'o) t -> F.t
  val set_frequencies : ?paranoid:bool -> F.t -> ('i, 'o) t -> ('i, 'o) t
  val finish : ('x, 'x) t -> ('x, 'x) t
  val no_flush : int -> int -> ('x, 'x) t -> ('x, 'x) t
  val partial_flush : int -> int -> ('x, 'x) t -> ('x, 'x) t
  val sync_flush : int -> int -> ('x, 'x) t -> ('x, 'x) t
  val full_flush : int -> int -> ('x, 'x) t -> ('x, 'x) t

  type meth = PARTIAL | SYNC | FULL

  val flush_of_meth : meth -> int -> int -> ('x, 'x) t -> ('x, 'x) t
  val flush : int -> int -> ('i, 'o) t -> ('i, 'o) t

  val eval :
       'a
    -> 'a
    -> ('a, 'a) t
    -> [ `Await of ('a, 'a) t
       | `Flush of ('a, 'a) t
       | `End of ('a, 'a) t
       | `Error of ('a, 'a) t * error ]

  val used_in : ('i, 'o) t -> int
  val used_out : ('i, 'o) t -> int
  val default : witness:'a B.t -> ?wbits:int -> int -> ('a, 'a) t

  val to_result :
       'a
    -> 'a
    -> ?meth:meth * int
    -> ('a -> int option -> int)
    -> ('a -> int -> int)
    -> ('a, 'a) t
    -> (('a, 'a) t, error) result

  val bytes :
       Bytes.t
    -> Bytes.t
    -> ?meth:meth * int
    -> (Bytes.t -> int option -> int)
    -> (Bytes.t -> int -> int)
    -> (Bytes.t, Bytes.t) t
    -> ((Bytes.t, Bytes.t) t, error) result

  val bigstring :
       B.Bigstring.t
    -> B.Bigstring.t
    -> ?meth:meth * int
    -> (B.Bigstring.t -> int option -> int)
    -> (B.Bigstring.t -> int -> int)
    -> (B.Bigstring.t, B.Bigstring.t) t
    -> ((B.Bigstring.t, B.Bigstring.t) t, error) result
end

type error_rfc1951_deflate = Decompress_impl.error_rfc1951_deflate =
  | Lz77 of L.error

module RFC1951_deflate = Decompress_impl.RFC1951_deflate

type error_z_deflate = Decompress_impl.error_z_deflate =
  | RFC1951 of error_rfc1951_deflate

module Zlib_deflate = Decompress_impl.Zlib_deflate
module Window = Decompress_impl.Window

module type INFLATE = sig
  type error
  type ('i, 'o) t

  val pp_error : Format.formatter -> error -> unit
  val pp : Format.formatter -> ('i, 'o) t -> unit

  val eval :
       'a
    -> 'a
    -> ('a, 'a) t
    -> [ `Await of ('a, 'a) t
       | `Flush of ('a, 'a) t
       | `End of ('a, 'a) t
       | `Error of ('a, 'a) t * error ]

  val refill : int -> int -> ('i, 'o) t -> ('i, 'o) t
  val flush : int -> int -> ('i, 'o) t -> ('i, 'o) t
  val used_in : ('i, 'o) t -> int
  val used_out : ('i, 'o) t -> int
  val write : ('i, 'o) t -> int

  val to_result :
       'a
    -> 'a
    -> ('a -> int)
    -> ('a -> int -> int)
    -> ('a, 'a) t
    -> (('a, 'a) t, error) result

  val bytes :
       Bytes.t
    -> Bytes.t
    -> (Bytes.t -> int)
    -> (Bytes.t -> int -> int)
    -> (Bytes.t, Bytes.t) t
    -> ((Bytes.t, Bytes.t) t, error) result

  val bigstring :
       B.Bigstring.t
    -> B.Bigstring.t
    -> (B.Bigstring.t -> int)
    -> (B.Bigstring.t -> int -> int)
    -> (B.Bigstring.t, B.Bigstring.t) t
    -> ((B.Bigstring.t, B.Bigstring.t) t, error) result
end

type error_rfc1951_inflate = Decompress_impl.error_rfc1951_inflate =
  | Invalid_kind_of_block
  | Invalid_complement_of_length
  | Invalid_dictionary
  | Invalid_distance_code
  | Invalid_distance of {distance: int; max: int}

module RFC1951_inflate = Decompress_impl.RFC1951_inflate

type error_z_inflate = Decompress_impl.error_z_inflate =
  | RFC1951 of RFC1951_inflate.error
  | Invalid_header
  | Invalid_checksum of {have: Checkseum.Adler32.t; expect: Checkseum.Adler32.t}

module Zlib_inflate = Decompress_impl.Zlib_inflate
OCaml

Innovation. Community. Security.