Skip to content

Document the restrictions on the :buffer keyword of Zlib::Inflate#inflate #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mame merged 1 commit into from
Oct 24, 2026
+6 −0
Merged

Document the restrictions on the :buffer keyword of Zlib::Inflate#inflate #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ext/zlib/zlib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2271,6 +2271,12 @@ rb_inflate_inflate_body(VALUE _arguments)
* :buffer keyword argument.
* * When passing a block, the yielded chunks will be the same value as the
* :buffer keyword argument.
* * When using the :buffer keyword argument, pass the same String object in
* every call to this method on the stream, from the first call until the
* stream is finished, and do not modify it other than through this method
* until then. Also, do not mix it with other methods that produce output,
* such as #<< and Zlib::ZStream#finish. Otherwise, the behavior is
* undefined.
*
* Raises a Zlib::NeedDict exception if a preset dictionary is needed to
* decompress. Set the dictionary by Zlib::Inflate#set_dictionary and then
Expand Down
Loading