1 files changed, 31 insertions, 0 deletions
diff --git a/doc/stringio/each_char.rdoc b/doc/stringio/each_char.rdoc
new file mode 100644
index 0000000000..bec5ecac3f
--- /dev/null
+++ b/doc/stringio/each_char.rdoc
@@ -0,0 +1,31 @@
+With a block given, calls the block with each remaining character in the stream;
+positions the stream at end-of-file;
+returns +self+:
+
+  chars = []
+  strio = StringIO.new('hello')
+  strio.each_char {|char| chars.push(char) }
+  strio.eof? # => true
+  chars      # => ["h", "e", "l", "l", "o"]
+
+  chars = []
+  strio = StringIO.new('こんにちは')
+  strio.each_char {|char| chars.push(char) }
+  chars      # => ["こ", "ん", "に", "ち", "は"]
+
+Stream position matters:
+
+ chars = []
+ strio = StringIO.new('こんにちは')
+ strio.getc # => "こ"
+ strio.pos  # => 3  # 3-byte character was read.
+ strio.each_char {|char| chars.push(char) }
+ chars      # => ["ん", "に", "ち", "は"]
+
+When at end-of-stream does not call the block:
+
+  strio.eof? # => true
+  strio.each_char {|char| fail 'Boo!' }
+  strio.eof? # => true
+
+With no block given, returns a new {Enumerator}[rdoc-ref:Enumerator].