Module: IO::generic_readable
| Relationships & Source Files | |
| Extension / Inclusion / Inheritance Descendants | |
|
Included In:
| |
| Defined in: | ext/stringio/stringio.c |
Instance Method Summary
-
#read_nonblock(integer[, outbuf [, opts]]) ⇒ String
Similar to
#read, but raisesEOFErrorat end of string unless the exception: false option is passed in. -
#readbyte ⇒ byte
Like
getbyte, but raises an exception if already at end-of-stream; see Byte IO. -
#readchar ⇒ String
Like
getc, but raises an exception if already at end-of-stream; see Character IO. -
#readline(sep = $/, chomp: false) ⇒ String
Reads a line as with
IO#gets, but raises EOFError if already at end-of-file; see Line IO. -
#readpartial(integer[, outbuf]) ⇒ String
Alias for #sysread.
-
#sysread(integer[, outbuf]) ⇒ String
(also: #readpartial)
Similar to
#read, but raisesEOFErrorat end of string instead of returningnil, as well asIO#sysreaddoes.
Instance Method Details
#read_nonblock(integer[, outbuf [, opts]]) ⇒ String
Similar to #read, but raises EOFError at end of string unless the exception: false option is passed in.
# File 'ext/stringio/stringio.c', line 1680
static VALUE
strio_read_nonblock(int argc, VALUE *argv, VALUE self)
{
VALUE opts = Qnil, val;
rb_scan_args(argc, argv, "11:", NULL, NULL, &opts);
if (!NIL_P(opts)) {
argc--;
}
val = strio_read(argc, argv, self);
if (NIL_P(val)) {
if (!NIL_P(opts) &&
rb_hash_lookup2(opts, sym_exception, Qundef) == Qfalse)
return Qnil;
else
rb_eof_error();
}
return val;
}
#readbyte ⇒ byte
Like getbyte, but raises an exception if already at end-of-stream; see Byte IO.
# File 'ext/stringio/stringio.c', line 1046
static VALUE
strio_readbyte(VALUE self)
{
VALUE c = rb_funcallv(self, rb_intern("getbyte"), 0, 0);
if (NIL_P(c)) rb_eof_error();
return c;
}
#readchar ⇒ String
Like getc, but raises an exception if already at end-of-stream; see Character IO.
# File 'ext/stringio/stringio.c', line 1031
static VALUE
strio_readchar(VALUE self)
{
VALUE c = rb_funcallv(self, rb_intern("getc"), 0, 0);
if (NIL_P(c)) rb_eof_error();
return c;
}
#readline(sep = $/, chomp: false) ⇒ String
#readline(limit, chomp: false) ⇒ String
#readline(sep, limit, chomp: false) ⇒ String
String
#readline(limit, chomp: false) ⇒ String
#readline(sep, limit, chomp: false) ⇒ String
Reads a line as with IO#gets, but raises EOFError if already at end-of-file; see Line IO.
# File 'ext/stringio/stringio.c', line 1346
static VALUE
strio_readline(int argc, VALUE *argv, VALUE self)
{
VALUE line = rb_funcallv_kw(self, rb_intern("gets"), argc, argv, RB_PASS_CALLED_KEYWORDS);
if (NIL_P(line)) rb_eof_error();
return line;
}
#sysread(integer[, outbuf]) ⇒ String
#readpartial(integer[, outbuf]) ⇒ String
String
#readpartial(integer[, outbuf]) ⇒ String
Alias for #sysread.
#sysread(integer[, outbuf]) ⇒ String
#readpartial(integer[, outbuf]) ⇒ String
Also known as: #readpartial
String
#readpartial(integer[, outbuf]) ⇒ String
Similar to #read, but raises EOFError at end of string instead of returning nil, as well as IO#sysread does.
# File 'ext/stringio/stringio.c', line 1663
static VALUE
strio_sysread(int argc, VALUE *argv, VALUE self)
{
VALUE val = rb_funcallv_kw(self, rb_intern("read"), argc, argv, RB_PASS_CALLED_KEYWORDS);
if (NIL_P(val)) {
rb_eof_error();
}
return val;
}