Don't treat Z_BUF_ERROR as a fatal error #6
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously Z_BUF_ERROR error code was treated as fatal and it raised an exception in OCaml. However the error is not fatal according to zlib documentation [1]. Handling this is necessary for streaming compression where you never finish the stream with Z_FINISH. Seems like ignoring the error is sufficient as returned values for used_in and used_out will be 0 in case it happens. Documentation says: "this is simply an indication that deflate() could not consume more input or produce more output. deflate() can be called again with more output space or more available input, which it will be in this code." [1] https://zlib.net/zlib_how.html
Laakeri
pushed a commit
to Laakeri/camlzip
that referenced
this pull request
Jul 27, 2017
Add {deflate,inflate}_bigstring similar to {delfate,inflate} that
read from / write to bigstrings instead of bytes.
bigstring is defined as:
type bigstring = (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t
See https://github.com/ocaml/ocaml/blob/trunk/bytecomp/lambda.ml#L138
The Z_BUF_ERROR fix (GPR xavierleroy#6) is included in the new C functions camlzip_deflate_bigstring and camlzip_inflate_bigstring.
|
Merged by commit [master 20a0ae2] |
xavierleroy
pushed a commit
that referenced
this pull request
Oct 4, 2024
Add {deflate,inflate}_bigstring similar to {delfate,inflate} that
read from / write to bigstrings instead of bytes.
bigstring is defined as:
type bigstring = (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t
See https://github.com/ocaml/ocaml/blob/trunk/bytecomp/lambda.ml#L138
The Z_BUF_ERROR fix (GPR #6) is included in the new C functions camlzip_deflate_bigstring and camlzip_inflate_bigstring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously Z_BUF_ERROR error code was treated as fatal and it raised an exception in OCaml. However the error is not fatal according to zlib documentation [1].
Handling this is necessary for streaming compression where you never finish the stream with Z_FINISH.
Seems like ignoring the error is sufficient as returned values for used_in and used_out will be 0 in case it happens.
Documentation says:
"this is simply an indication that deflate() could not consume more input or produce more output. deflate() can be called again with more output space or more available input, which it will be in this code."
[1] https://zlib.net/zlib_how.html