summaryrefslogtreecommitdiff
path: root/ext/pty/lib/expect.rb
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-02-06 14:31:32 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-02-06 14:31:32 +0000
commita493ec0388b07052d315b86bc794f5bac946a6d3 (patch)
tree9f9c10f0455556c7563a81de71ab07061caefadb /ext/pty/lib/expect.rb
parente45e06410dd36e313ea3456ba406e31f66034a2e (diff)
* doc/pty/README.expect: Removed static documentation file
* ext/pty/lib/expect.rb: Documentation for IO#expect git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39117 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/pty/lib/expect.rb')
-rw-r--r--ext/pty/lib/expect.rb22
1 files changed, 21 insertions, 1 deletions
diff --git a/ext/pty/lib/expect.rb b/ext/pty/lib/expect.rb
index c15044b..06f4243 100644
--- a/ext/pty/lib/expect.rb
+++ b/ext/pty/lib/expect.rb
@@ -1,10 +1,30 @@
$expect_verbose = false
+# Expect library adds the IO instance method #expect, which does similar act to
+# tcl's expect extension.
+#
+# In order to use this method, you must require expect:
+#
+# require 'expect'
+#
+# Please see #expect for usage.
class IO
- # Reads from the IO until pattern +pat+ matches or the +timeout+ is over.
+ # call-seq:
+ # IO#expect(pattern,timeout=9999999) -> Array
+ # IO#expect(pattern,timeout=9999999) { |result| ... } -> nil
+ #
+ # Reads from the IO until the given +pattern+ matches or the +timeout+ is over.
+ #
# It returns an array with the read buffer, followed by the matches.
# If a block is given, the result is yielded to the block and returns nil.
#
+ # When called without a block, it waits until the input that matches the
+ # given +pattern+ is obtained from the IO or the time specified as the
+ # timeout passes. An array is returned when the pattern is obtained from the
+ # IO. The first element of the array is the entire string obtained from the
+ # IO until the pattern matches, followed by elements indicating which the
+ # pattern which matched to the anchor in the regular expression.
+ #
# The optional timeout parameter defines, in seconds, the total time to wait
# for the pattern. If the timeout expires or eof is found, nil is returned
# or yielded. However, the buffer in a timeout session is kept for the next