instance method

Dir#read

() -> ::String?

read → string or nil

static VALUE
dir_read(VALUE dir)
{
    struct dir_data *dirp;
    struct dirent *dp;

    GetDIR(dir, dirp);
    rb_errno_set(0);
    if ((dp = READDIR(dirp->dir, dirp->enc)) != NULL) {
        return rb_external_str_new_with_enc(dp->d_name, NAMLEN(dp), dirp->enc);
    }
    else {
        int e = errno;
        if (e != 0) rb_syserr_fail(e, 0);
        return Qnil;            /* end of stream */
    }
}

Reads and returns the next entry name from self; returns nil if at end-of-stream; see Dir As Stream-Like:

Example

dir = Dir.new('example')
dir.read # => "."
dir.read # => ".."
dir.read # => "config.h"

See also #pos= #rewind #pos #seek also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#pos= next ›#rewind