[前][次][番号順一覧][スレッド一覧]

ruby-changes:15686

From: naruse <ko1@a...>
Date: Tue, 4 May 2010 07:19:48 +0900 (JST)
Subject: [ruby-changes:15686] Ruby:r27604 (trunk): Add rdoc about IO#read(length).

naruse	2010-05-04 07:17:49 +0900 (Tue, 04 May 2010)

  New Revision: 27604

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=27604

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

  Modified files:
    trunk/io.c

Index: io.c
===================================================================
--- io.c	(revision 27603)
+++ io.c	(revision 27604)
@@ -2095,14 +2095,15 @@
  *
  *  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,
- *  it try to read <i>length</i> bytes.
- *  It returns nil or a string which length is 1 to <i>length</i> bytes.
- *  nil means it met EOF at beginning.
+ *  it try to read <i>length</i> bytes without any conversion (binary mode).
+ *  It returns <code>nil</code> or a string whose length is 1 to <i>length</i> bytes.
+ *  <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 <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>,
  *  it reads until EOF and the encoding conversion is applied.
@@ -2117,7 +2118,7 @@
  *  depend on <i>length</i>.
  *  <code><i>ios</i>.read()</code> and
  *  <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.read(16)   #=> "This is line one"

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]