Repository navigation
Type Zlib::GzipReader#read without a length as returning String - #3315
Merged
Merged
Conversation
Like IO#read, GzipReader#read reads to the end of the stream when the length is nil or omitted, and returns an empty string at the end of the stream rather than nil. Only a read with a length returns nil there.
This file contains hidden or 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
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.
Zlib::GzipReader#readwas typed(?int? length, ?string? outbuf) -> String?, sogz.read.upcasewas a type error. Without a length,rb_gzreader_readcallsgzfile_read_all, which returns an empty string at the end of the stream, nevernil. Onlygzfile_readwith a length returnsnilthere:This splits it the same way
IO#readalready is:test_readnow checks the exact return types, including""fromreadandnilfromread(1)once the stream is exhausted. It passes on Ruby 3.4 and 4.0.7. The runtime type check can't tellStringfromString?, so the test can't fail on master. Steep shows the difference:gz.read.upcaseandgz.read(nil, buf).upcaseare errors on master and pass here, whilegz.read(3).upcaseis still an error.rbs -r zlib validatepasses andrake annotateleaves the file unchanged.This touches the same files as #3314 but merges cleanly with it, and the zlib tests pass with both applied.