1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update readpartial doc.

Browse Source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10149 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
akr 2006-05-13 07:43:41 +00:00
parent 55fc4f0c27
commit 52d0a1624c
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
io.c
View File

@ -1293,10 +1293,12 @@ io_getpartial(int argc, VALUE *argv, VALUE io)
/* /*
* call-seq: * call-seq:
* ios.readpartial(maxlen[, outbuf]) => string, outbuf * ios.readpartial(maxlen) => string
* ios.readpartial(maxlen, outbuf) => outbuf
* *
* Reads at most <i>maxlen</i> bytes from the I/O stream but * Reads at most <i>maxlen</i> bytes from the I/O stream.
* it blocks only if <em>ios</em> has no data immediately available. * It blocks only if <em>ios</em> has no data immediately available.
* It doesn't block if some data available.
* If the optional <i>outbuf</i> argument is present, * If the optional <i>outbuf</i> argument is present,
* it must reference a String, which will receive the data. * it must reference a String, which will receive the data.
* It raises <code>EOFError</code> on end of file. * It raises <code>EOFError</code> on end of file.
@ -1336,11 +1338,13 @@ io_getpartial(int argc, VALUE *argv, VALUE io)
* r.readpartial(4096) #=> "def\n" "" "ghi\n" * r.readpartial(4096) #=> "def\n" "" "ghi\n"
* r.readpartial(4096) #=> "ghi\n" "" "" * r.readpartial(4096) #=> "ghi\n" "" ""
* *
* Note that readpartial is nonblocking-flag insensitive. * Note that readpartial behaves similar to sysread.
* It blocks on the situation IO#sysread causes Errno::EAGAIN. * The differences are:
* * If the buffer is not empty, read from the buffer instead of "sysread for buffered IO (IOError)".
* * It doesn't cause Errno::EAGAIN and Errno::EINTR. When readpartial meets EAGAIN and EINTR by read system call, readpartial retry the system call.
* *
* Also note that readpartial behaves similar to sysread in blocking mode. * The later means that readpartial is nonblocking-flag insensitive.
* The behavior is identical when the buffer is empty. * It blocks on the situation IO#sysread causes Errno::EAGAIN as if the fd is blocking mode.
* *
*/ */