archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[DOC] {read,write}_nonblock with exception: false

Browse source 
Update docs to reflect EOF behavior change of read_nonblock and
write_nonblock when using `exception: false`.

[Fix GH-1527]
Author:    Russell Davis <russell-stripe@users.noreply.github.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57690 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nobu 2017-02-23 01:15:27 +00:00
parent 2e2063fe16
commit d5eef0301a
4 changed files with 28 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

6
prelude.rb
View file

@ -70,7 +70,8 @@ class IO
#
# By specifying `exception: false`, the options hash allows you to indicate
# that read_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol :wait_readable instead.
# return the symbol :wait_readable instead. At EOF, it will return nil instead
# of raising EOFError.
def read_nonblock(len, buf = nil, exception: true)
__read_nonblock(len, buf, exception)
end
@ -128,7 +129,8 @@ class IO
#
# By specifying `exception: false`, the options hash allows you to indicate
# that write_nonblock should not raise an IO::WaitWritable exception, but
# return the symbol :wait_writable instead.
# return the symbol :wait_writable instead. At EOF, it will return nil instead
# of raising EOFError.
def write_nonblock(buf, exception: true)
__write_nonblock(buf, exception)
end