Improve IO#read, IO#readpartial, IO#write and IO.copy_stream #521
Conversation
This change aims to improve the following method signatures of the `IO` class: - `#read` - `#readpartial` - `#write` - `.copy_stream`
| # need the behavior like a single read(2) system call, consider #readpartial, | ||
| # #read_nonblock, and #sysread. | ||
| # | ||
| def read: (?Integer? length, ?String outbuf) -> String? |
There was a problem hiding this comment.
[note] Make the first argument type nilable because the API doc says:
length must be a non-negative integer or
nil.
-def read: (?Integer length, ?String outbuf) -> String?
+def read: (?Integer? length, ?String outbuf) -> String?| # on the situation IO#sysread causes Errno::EWOULDBLOCK as if the fd is blocking | ||
| # mode. | ||
| # | ||
| def readpartial: (Integer maxlen, ?String outbuf) -> String |
There was a problem hiding this comment.
[note] Simplify overloading.
-def readpartial: (Integer maxlen) -> String
- | (Integer maxlen, ?String outbuf) -> String
+def readpartial: (Integer maxlen, ?String outbuf) -> String| # This is a test | ||
| # That was 15 bytes of data | ||
| # | ||
| def write: (*_ToS string) -> Integer |
There was a problem hiding this comment.
[note] Rename the argument (arg0 -> string) for readability according to the API doc.
| # When *src_offset* is specified and *src* is an IO, IO.copy_stream doesn't move | ||
| # the current file offset. | ||
| # | ||
| def self.copy_stream: ((String | _Reader | _ReaderPartial) src, (String | _Writer) dst, ?Integer copy_length, ?Integer src_offset) -> Integer |
There was a problem hiding this comment.
[note] Make the argument types more accurate according to the API doc:
IO.copy_streamcopies src to dst. src and dst is either a filename or an IO-like object. IO-like object for src should have#readpartialor#readmethod. IO-like object for dst should have#writemethod.
-def self.copy_stream: (_Reader src, _Writer dst, ?Integer copy_length, ?Integer src_offset) -> Integer
+def self.copy_stream: ((String | _Reader | _ReaderPartial) src, (String | _Writer) dst, ?Integer copy_length, ?Integer src_offset) -> IntegerI've added a new interface _ReaderPartial (like _Reader) to core/builtin.rbs.
Please teach me if there is a better name than _ReaderPartial.
This change aims to improve the following method signatures of the
IOclass:#read#readpartial#write.copy_streamIn creating this change, I refer to the following resources: