module IO::generic_readable - Documentation for Ruby 3.2

# module IO::generic_readable

### Public Instance Methods

getch(min: nil, time: nil, intr: nil) → char click to toggle source

See `IO#getch`.

    static VALUE
    io_getch(int argc, VALUE *argv, VALUE io)
    {
        return rb_funcallv(io, id_getc, argc, argv);
    }

getpass(prompt=nil) → string click to toggle source

See `IO#getpass`.

    static VALUE
    io_getpass(int argc, VALUE *argv, VALUE io)
    {
        VALUE str;

        rb_check_arity(argc, 0, 1);
        prompt(argc, argv, io);
        str = str_chomp(rb_funcallv(io, id_gets, 0, 0));
        puts_call(io);
        return str;
    }

read_nonblock(integer[, outbuf [, opts]]) → string click to toggle source

Similar to read, but raises `EOFError` at end of string unless the +exception: false+ option is passed in.

    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 click to toggle source

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

    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 click to toggle source

Like `getc`, but raises an exception if already at end-of-stream; see Character IO.

    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 click to toggle source
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.

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

readpartial(integer[, outbuf]) → string

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

Alias for: sysread
sysread(integer[, outbuf]) → string click to toggle source

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

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

Also aliased as: readpartial