Sha256: b1930468497fd5257ff48e6896997b84c1346188edfc29c2555bbe5589b41700

Contents?: true

Size: 1.68 KB

Versions: 12

Compression:

Stored size: 1.68 KB

Contents

o:$YARD::CodeObjects::MethodObject:
@name:	read:@docstringIC:YARD::Docstring"ÔReads the next entry from <em>dir</em> and returns it as a string.
Returns <code>nil</code> at the end of the stream.

   d = Dir.new("testdir")
   d.read   #=> "."
   d.read   #=> ".."
   d.read   #=> "config.h"
:@objectu:YARD::StubProxy
Dir#read:
@summary0:	@all"ýReads the next entry from <em>dir</em> and returns it as a string.
Returns <code>nil</code> at the end of the stream.

   d = Dir.new("testdir")
   d.read   #=> "."
   d.read   #=> ".."
   d.read   #=> "config.h"


@overload read
  @return [String, nil]:@ref_tags[:
@tags[o:YARD::Tags::OverloadTag
;
u;
Dir#read;;;IC;	"
;
u;
Dir#read;0;
"@return [String, nil];[;[o:YARD::Tags::Tag
;
0;0:@types["String"nil:
@text":@tag_name"return;0:@parameters[;0:@signature"	read;"
overload:@current_file_has_commentsF:@scope:
instance;[:@docstring_extra0:@files[["
dir.c0:@namespaceu;Dir:
@path"
Dir#read;[:@visibility:public:@source"¬/*
 *  call-seq:
 *     dir.read => string or nil
 *
 *  Reads the next entry from <em>dir</em> and returns it as a string.
 *  Returns <code>nil</code> at the end of the stream.
 *
 *     d = Dir.new("testdir")
 *     d.read   #=> "."
 *     d.read   #=> ".."
 *     d.read   #=> "config.h"
 */
static VALUE
dir_read(dir)
    VALUE dir;
{
    struct dir_data *dirp;
    struct dirent *dp;

    GetDIR(dir, dirp);
    errno = 0;
    dp = readdir(dirp->dir);
    if (dp) {
    return rb_tainted_str_new(dp->d_name, NAMLEN(dp));
    }
    else if (errno == 0) {  /* end of stream */
    return Qnil;
    }
    else {
    rb_sys_fail(0);
    }
    return Qnil;        /* not reached */
}:@source_type:c

Version data entries

12 entries across 12 versions & 2 rubygems

Version Path
pry-doc-0.4.4 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.4.3 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.4.2 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.4.1 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.4.0 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.3.0 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.2.4pre1 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.2.3pre1 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.2.1 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.2.0 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-doc-0.1.5pre1 lib/pry-doc/core_docs_18/objects/Dir/read_i.dat
pry-0.6.9pre1-i386-mingw32 lib/pry/core_docs_18/objects/Dir/read_i.dat