summaryrefslogtreecommitdiff
path: root/lib/readbytes.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/readbytes.rb')
-rw-r--r--lib/readbytes.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/readbytes.rb b/lib/readbytes.rb
index d6a3b10afe..08b92da73c 100644
--- a/lib/readbytes.rb
+++ b/lib/readbytes.rb
@@ -12,6 +12,11 @@ class TruncatedDataError<IOError
end
class IO
+ # reads exactly n bytes from the IO stream.
+ # If the data read is nil, raises EOFError.
+ # If the data read is too short, raises TruncatedDataError.
+ # The method TruncatedDataError#data may be used to obtain
+ # the truncated message.
def readbytes(n)
str = read(n)
if str == nil