kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Add rdoc about IO#read(length). [ruby-core:29161]

Browse source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27604 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
naruse 2010-05-03 22:17:49 +00:00
parent 9526ba4ef3
commit e6ccffd966
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
io.c
View file

@ -2095,14 +2095,15 @@ rb_io_write_nonblock(VALUE io, VALUE str)
* *
* Reads <i>length</i> bytes from the I/O stream. * Reads <i>length</i> bytes from the I/O stream.
* *
* <i>length</i> must be a non-negative integer or nil. * <i>length</i> must be a non-negative integer or <code>nil</code>.
* *
* If <i>length</i> is a positive integer, * If <i>length</i> is a positive integer,
* it try to read <i>length</i> bytes. * it try to read <i>length</i> bytes without any conversion (binary mode).
* It returns nil or a string which length is 1 to <i>length</i> bytes. * It returns <code>nil</code> or a string whose length is 1 to <i>length</i> bytes.
* nil means it met EOF at beginning. * <code>nil</code> means it met EOF at beginning.
* The 1 to <i>length</i>-1 bytes string means it met EOF after reading the result. * The 1 to <i>length</i>-1 bytes string means it met EOF after reading the result.
* The <i>length</i> bytes string means it doesn't meet EOF. * The <i>length</i> bytes string means it doesn't meet EOF.
* The resulted string is always ASCII-8BIT encoding.
* *
* If <i>length</i> is omitted or is <code>nil</code>, * If <i>length</i> is omitted or is <code>nil</code>,
* it reads until EOF and the encoding conversion is applied. * it reads until EOF and the encoding conversion is applied.
@ -2117,7 +2118,7 @@ rb_io_write_nonblock(VALUE io, VALUE str)
* depend on <i>length</i>. * depend on <i>length</i>.
* <code><i>ios</i>.read()</code> and * <code><i>ios</i>.read()</code> and
* <code><i>ios</i>.read(nil)</code> returns <code>""</code>. * <code><i>ios</i>.read(nil)</code> returns <code>""</code>.
* <code><i>ios</i>.read(<i>positive-integer</i>)</code> returns nil. * <code><i>ios</i>.read(<i>positive-integer</i>)</code> returns <code>nil</code>.
* *
* f = File.new("testfile") * f = File.new("testfile")
* f.read(16) #=> "This is line one" * f.read(16) #=> "This is line one"