Module: IO::generic_readable

Included in:
StringIO
Defined in:
docs/io.rb,
ext/stringio/stringio.c

Instance Method Summary collapse

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.

Returns:

  • (String) 


1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
 
# File 'ext/stringio/stringio.c', line 1711

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 ⇒ Object

Like getbyte, but raises an exception if already at end-of-stream; see Byte IO.



1071
1072
1073
1074
1075
1076
1077
 
# File 'ext/stringio/stringio.c', line 1071

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.

Returns:

  • (String) 


1056
1057
1058
1059
1060
1061
1062
 
# File 'ext/stringio/stringio.c', line 1056

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

Reads a line as with IO#gets, but raises EOFError if already at end-of-file; see Line IO.

Overloads:

  • #readline(sep = $/, chomp: false) ⇒ String

    Returns:

    • (String)
  • #readline(limit, chomp: false) ⇒ String

    Returns:

    • (String)
  • #readline(sep, limit, chomp: false) ⇒ String

    Returns:

    • (String) 


1372
1373
1374
1375
1376
1377
1378
 
# File 'ext/stringio/stringio.c', line 1372

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

Similar to #read, but raises EOFError at end of string instead of returning nil, as well as IO#sysread does.

Overloads:

  • #sysread(integer[, outbuf]) ⇒ String

    Returns:

    • (String)
  • #readpartial(integer[, outbuf]) ⇒ String

    Returns:

    • (String) 


1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'ext/stringio/stringio.c', line 1694

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;
}

#sysread(integer[, outbuf]) ⇒ 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.

Overloads:

  • #sysread(integer[, outbuf]) ⇒ String

    Returns:

    • (String)
  • #readpartial(integer[, outbuf]) ⇒ String

    Returns:

    • (String) 


1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'ext/stringio/stringio.c', line 1694

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;
}