Class: Dir

Inherits:

Object

Object
Dir

show all

Includes:: Enumerable

Defined in:: dir.c

Overview

Objects of class Dir are directory streams representing directories in the underlying file system. They provide a variety of ways to list directories and their contents. See also File.

The directory used in these examples contains the two regular files (config.h and main.rb), the parent directory (..), and the directory itself (.).

Class Method Summary collapse

.[] ⇒ Object

Equivalent to calling Dir.glob(array,0) and Dir.glob([string,...],0).
.chdir ⇒ Object

Changes the current working directory of the process to the given string.
.chroot(string) ⇒ 0

Changes this process's idea of the file system root.
.delete ⇒ Object

Deletes the named directory.
.entries(dirname) ⇒ Array

Returns an array containing all of the filenames in the given directory.
.exist? ⇒ Object

call-seq: File.directory?(file_name) -> true or false.
.exists? ⇒ Object

call-seq: File.directory?(file_name) -> true or false.
.foreach ⇒ Object

Calls the block once for each entry in the named directory, passing the filename of each entry as a parameter to the block.
.getwd ⇒ Object

Returns the path to the current working directory of this process as a string.
.glob ⇒ Object

Returns the filenames found by expanding pattern which is an Array of the patterns or the pattern String, either as an array or as parameters to the block.
.home ⇒ Object

Returns the home directory of the current user or the named user if given.
.mkdir(string[, integer]) ⇒ 0

Makes a new directory named by string, with permissions specified by the optional parameter anInteger.
.open ⇒ Object

With no block, open is a synonym for Dir::new.
.pwd ⇒ Object

Returns the path to the current working directory of this process as a string.
.rmdir ⇒ Object

Deletes the named directory.
.unlink ⇒ Object

Deletes the named directory.

Instance Method Summary collapse

#close ⇒ nil

Closes the directory stream.
#each ⇒ Object

Calls the block once for each entry in this directory, passing the filename of each entry as a parameter to the block.
#new(string) ⇒ Dir constructor

Returns a new directory object for the named directory.
#inspect ⇒ String

Return a string describing this Dir object.
#path ⇒ String^?

Returns the path parameter passed to dir's constructor.
#pos ⇒ Object

Returns the current position in dir.
#pos(integer) ⇒ Integer

Synonym for Dir#seek, but returns the position parameter.
#read ⇒ String^?

Reads the next entry from dir and returns it as a string.
#rewind ⇒ Dir

Repositions dir to the first entry.
#seek(integer) ⇒ Dir

Seeks to a particular location in dir.
#tell ⇒ Object

Returns the current position in dir.
#path ⇒ String^?

Returns the path parameter passed to dir's constructor.

Methods included from Enumerable

#all?, #any?, #chunk, #collect, #collect_concat, #count, #cycle, #detect, #drop, #drop_while, #each_cons, #each_entry, #each_slice, #each_with_index, #each_with_object, #entries, #find, #find_all, #find_index, #first, #flat_map, #grep, #group_by, #include?, #inject, #map, #max, #max_by, #member?, #min, #min_by, #minmax, #minmax_by, #none?, #one?, #partition, #reduce, #reject, #reverse_each, #select, #slice_before, #sort, #sort_by, #take, #take_while, #to_a, #zip

Constructor Details

#new(string) ⇒ `Dir`

Returns a new directory object for the named directory.

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.new( string ) -> aDir
 *
 *  Returns a new directory object for the named directory.
 */
static VALUE
dir_initialize(int argc, VALUE *argv, VALUE dir)
{
    struct dir_data *dp;
    rb_encoding  *fsenc;
    VALUE dirname, opt;
    static VALUE sym_enc;

    if (!sym_enc) {
    sym_enc = ID2SYM(rb_intern("encoding"));
    }
    fsenc = rb_filesystem_encoding();

    rb_scan_args(argc, argv, "11", &dirname, &opt);

    if (!NIL_P(opt)) {
        VALUE v, enc=Qnil;
        opt = rb_convert_type(opt, T_HASH, "Hash", "to_hash");

        v = rb_hash_aref(opt, sym_enc);
        if (!NIL_P(v)) enc = v;

    if (!NIL_P(enc)) {
        fsenc = rb_to_encoding(enc);
    }
    }

    GlobPathValue(dirname, FALSE);

    TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dp);
    if (dp->dir) closedir(dp->dir);
    dp->dir = NULL;
    dp->path = Qnil;
    dp->enc = fsenc;
    dp->dir = opendir(RSTRING_PTR(dirname));
    if (dp->dir == NULL) {
    if (errno == EMFILE || errno == ENFILE) {
        rb_gc();
        dp->dir = opendir(RSTRING_PTR(dirname));
    }
    if (dp->dir == NULL) {
        rb_sys_fail(RSTRING_PTR(dirname));
    }
    }
    dp->path = rb_str_dup_frozen(dirname);

    return dir;
}

Class Method Details

.[](array) ⇒ `Array` .[](string[, string ...)) ⇒ `Array`

Equivalent to calling Dir.glob(array,0) and Dir.glob([string,...],0).

Overloads:

.[](array) ⇒ Array
Returns:
- (Array)
.[](string[, string ...)) ⇒ Array
Returns:
- (Array)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir[ array ]                 -> array
 *     Dir[ string [, string ...] ] -> array
 *
 *  Equivalent to calling
 *  <code>Dir.glob(</code><i>array,</i><code>0)</code> and
 *  <code>Dir.glob([</code><i>string,...</i><code>],0)</code>.
 *
 */
static VALUE
dir_s_aref(int argc, VALUE *argv, VALUE obj)
{
    if (argc == 1) {
    return rb_push_glob(argv[0], 0);
    }
    return dir_globs(argc, argv, 0);
}

.chdir([ string]) ⇒ `0` .chdir([ string]) {|path| ... } ⇒ `Object`

Changes the current working directory of the process to the given string. When called without an argument, changes the directory to the value of the environment variable HOME, or LOGDIR. SystemCallError (probably Errno::ENOENT) if the target directory does not exist.

If a block is given, it is passed the name of the new current directory, and the block is executed with that as the current directory. The original working directory is restored when the block exits. The return value of chdir is the value of the block. chdir blocks can be nested, but in a multi-threaded program an error will be raised if a thread attempts to open a chdir block while another thread has one open.

Dir.chdir("/var/spool/mail")
puts Dir.pwd
Dir.chdir("/tmp") do
  puts Dir.pwd
  Dir.chdir("/usr") do
    puts Dir.pwd
  end
  puts Dir.pwd
end
puts Dir.pwd

produces:

/var/spool/mail
/tmp
/usr
/tmp
/var/spool/mail

Overloads:

.chdir([ string]) ⇒ 0
Returns:
- (0)
.chdir([ string]) {|path| ... } ⇒ Object
Yields:
- (path)
Returns:
- (Object)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.chdir( [ string] ) -> 0
 *     Dir.chdir( [ string] ) {| path | block }  -> anObject
 *
 *  Changes the current working directory of the process to the given
 *  string. When called without an argument, changes the directory to
 *  the value of the environment variable <code>HOME</code>, or
 *  <code>LOGDIR</code>. <code>SystemCallError</code> (probably
 *  <code>Errno::ENOENT</code>) if the target directory does not exist.
 *
 *  If a block is given, it is passed the name of the new current
 *  directory, and the block is executed with that as the current
 *  directory. The original working directory is restored when the block
 *  exits. The return value of <code>chdir</code> is the value of the
 *  block. <code>chdir</code> blocks can be nested, but in a
 *  multi-threaded program an error will be raised if a thread attempts
 *  to open a <code>chdir</code> block while another thread has one
 *  open.
 *
 *     Dir.chdir("/var/spool/mail")
 *     puts Dir.pwd
 *     Dir.chdir("/tmp") do
 *       puts Dir.pwd
 *       Dir.chdir("/usr") do
 *         puts Dir.pwd
 *       end
 *       puts Dir.pwd
 *     end
 *     puts Dir.pwd
 *
 *  <em>produces:</em>
 *
 *     /var/spool/mail
 *     /tmp
 *     /usr
 *     /tmp
 *     /var/spool/mail
 */
static VALUE
dir_s_chdir(int argc, VALUE *argv, VALUE obj)
{
    VALUE path = Qnil;

    rb_secure(2);
    if (rb_scan_args(argc, argv, "01", &path) == 1) {
    FilePathValue(path);
    }
    else {
    const char *dist = getenv("HOME");
    if (!dist) {
        dist = getenv("LOGDIR");
        if (!dist) rb_raise(rb_eArgError, "HOME/LOGDIR not set");
    }
    path = rb_str_new2(dist);
    }

    if (chdir_blocking > 0) {
    if (!rb_block_given_p() || rb_thread_current() != chdir_thread)
        rb_warn("conflicting chdir during another chdir block");
    }

    if (rb_block_given_p()) {
    struct chdir_data args;
    char *cwd = my_getcwd();

    args.old_path = rb_tainted_str_new2(cwd); xfree(cwd);
    args.new_path = path;
    args.done = FALSE;
    return rb_ensure(chdir_yield, (VALUE)&args, chdir_restore, (VALUE)&args);
    }
    dir_chdir(path);

    return INT2FIX(0);
}

.chroot(string) ⇒ `0`

Changes this process's idea of the file system root. Only a privileged process may make this call. Not available on all platforms. On Unix systems, see chroot(2) for more information.

Returns:

(0)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.chroot( string ) -> 0
 *
 *  Changes this process's idea of the file system root. Only a
 *  privileged process may make this call. Not available on all
 *  platforms. On Unix systems, see <code>chroot(2)</code> for more
 *  information.
 */
static VALUE
dir_s_chroot(VALUE dir, VALUE path)
{
    check_dirname(&path);

    path = rb_str_encode_ospath(path);
    if (chroot(RSTRING_PTR(path)) == -1)
    rb_sys_fail(RSTRING_PTR(path));

    return INT2FIX(0);
}

.delete(string) ⇒ `0` .rmdir(string) ⇒ `0` .unlink(string) ⇒ `0`

Deletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty.

Overloads:

.delete(string) ⇒ 0
Returns:
- (0)
.rmdir(string) ⇒ 0
Returns:
- (0)
.unlink(string) ⇒ 0
Returns:
- (0)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.delete( string ) -> 0
 *     Dir.rmdir( string ) -> 0
 *     Dir.unlink( string ) -> 0
 *
 *  Deletes the named directory. Raises a subclass of
 *  <code>SystemCallError</code> if the directory isn't empty.
 */
static VALUE
dir_s_rmdir(VALUE obj, VALUE dir)
{
    check_dirname(&dir);
    dir = rb_str_encode_ospath(dir);
    if (rmdir(RSTRING_PTR(dir)) < 0)
    rb_sys_fail(RSTRING_PTR(dir));

    return INT2FIX(0);
}

.entries(dirname) ⇒ `Array`

Returns an array containing all of the filenames in the given directory. Will raise a SystemCallError if the named directory doesn't exist.

Dir.entries("testdir")   #=> [".", "..", "config.h", "main.rb"]

Returns:

(Array)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.entries( dirname ) -> array
 *
 *  Returns an array containing all of the filenames in the given
 *  directory. Will raise a <code>SystemCallError</code> if the named
 *  directory doesn't exist.
 *
 *     Dir.entries("testdir")   #=> [".", "..", "config.h", "main.rb"]
 *
 */
static VALUE
dir_entries(int argc, VALUE *argv, VALUE io)
{
    VALUE dir;

    dir = dir_open_dir(argc, argv);
    return rb_ensure(rb_Array, dir, dir_close, dir);
}

.exist? ⇒ `Object`

call-seq:

File.directory?(file_name)   ->  true or false

Returns true if the named file is a directory, or a symlink that points at a directory, and false otherwise.

File.directory?(".")

# File 'dir.c'

/*
 * Document-method: directory?
 *
 * call-seq:
 *   File.directory?(file_name)   ->  true or false
 *
 * Returns <code>true</code> if the named file is a directory,
 * or a symlink that points at a directory, and <code>false</code>
 * otherwise.
 *
 *    File.directory?(".")
 */

VALUE
rb_file_directory_p(VALUE obj, VALUE fname)
{
#ifndef S_ISDIR
#   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
#endif

    struct stat st;

    if (rb_stat(fname, &st) < 0) return Qfalse;
    if (S_ISDIR(st.st_mode)) return Qtrue;
    return Qfalse;
}

.exists? ⇒ `Object`

call-seq:

File.directory?(file_name)   ->  true or false

Returns true if the named file is a directory, or a symlink that points at a directory, and false otherwise.

File.directory?(".")

# File 'dir.c'

/*
 * Document-method: directory?
 *
 * call-seq:
 *   File.directory?(file_name)   ->  true or false
 *
 * Returns <code>true</code> if the named file is a directory,
 * or a symlink that points at a directory, and <code>false</code>
 * otherwise.
 *
 *    File.directory?(".")
 */

VALUE
rb_file_directory_p(VALUE obj, VALUE fname)
{
#ifndef S_ISDIR
#   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
#endif

    struct stat st;

    if (rb_stat(fname, &st) < 0) return Qfalse;
    if (S_ISDIR(st.st_mode)) return Qtrue;
    return Qfalse;
}

.foreach(dirname) {|filename| ... } ⇒ `nil` .foreach(dirname) ⇒ `Object`

Calls the block once for each entry in the named directory, passing the filename of each entry as a parameter to the block.

If no block is given, an enumerator is returned instead.

Dir.foreach("testdir") {|x| puts "Got #{x}" }

produces:

Got .
Got ..
Got config.h
Got main.rb

Overloads:

.foreach(dirname) {|filename| ... } ⇒ nil
Yields:
- (filename)
Returns:
- (nil)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.foreach( dirname ) {| filename | block }  -> nil
 *     Dir.foreach( dirname )                        -> an_enumerator
 *
 *  Calls the block once for each entry in the named directory, passing
 *  the filename of each entry as a parameter to the block.
 *
 *  If no block is given, an enumerator is returned instead.
 *
 *     Dir.foreach("testdir") {|x| puts "Got #{x}" }
 *
 *  <em>produces:</em>
 *
 *     Got .
 *     Got ..
 *     Got config.h
 *     Got main.rb
 *
 */
static VALUE
dir_foreach(int argc, VALUE *argv, VALUE io)
{
    VALUE dir;

    RETURN_ENUMERATOR(io, argc, argv);
    dir = dir_open_dir(argc, argv);
    rb_ensure(dir_each, dir, dir_close, dir);
    return Qnil;
}

.getwd ⇒ `String` .pwd ⇒ `String`

Returns the path to the current working directory of this process as a string.

Dir.chdir("/tmp")   #=> 0
Dir.getwd           #=> "/tmp"

Overloads:

.getwd ⇒ String
Returns:
- (String)
.pwd ⇒ String
Returns:
- (String)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.getwd -> string
 *     Dir.pwd -> string
 *
 *  Returns the path to the current working directory of this process as
 *  a string.
 *
 *     Dir.chdir("/tmp")   #=> 0
 *     Dir.getwd           #=> "/tmp"
 */
static VALUE
dir_s_getwd(VALUE dir)
{
    return rb_dir_getwd();
}

.glob(pattern, [flags]) ⇒ `Array` .glob(pattern, [flags]) {|filename| ... } ⇒ `nil`

Returns the filenames found by expanding pattern which is an Array of the patterns or the pattern String, either as an array or as parameters to the block. Note that this pattern is not a regexp (it's closer to a shell glob). See File::fnmatch for the meaning of the flags parameter. Note that case sensitivity depends on your system (so File::FNM_CASEFOLD is ignored)

*: Matches any file. Can be restricted by other values in the glob. * will match all files; c* will match all files beginning with c; *c will match all files ending with c; and *c* will match all files that have c in them (including at the beginning or end). Equivalent to / .* /x in regexp. Note, this will not match Unix-like hidden files (dotfiles). In order to include those in the match results, you must use something like "*,*,.*".
**: Matches directories recursively.
?: Matches any one character. Equivalent to /.{1}/ in regexp.
[set]: Matches any one character in set. Behaves exactly like character sets in Regexp, including set negation ([^a-z]).
{p,q}: Matches either literal p or literal q. Matching literals may be more than one character in length. More than two literals may be specified. Equivalent to pattern alternation in regexp.
<code></code>: Escapes the next metacharacter. Note that this means you cannot use backslash in windows as part of a glob, i.e. Dir will not work use Dir instead

Dir["config.?"]                     #=> ["config.h"]
Dir.glob("config.?")                #=> ["config.h"]
Dir.glob("*.[a-z][a-z]")            #=> ["main.rb"]
Dir.glob("*.[^r]*")                 #=> ["config.h"]
Dir.glob("*.{rb,h}")                #=> ["main.rb", "config.h"]
Dir.glob("*")                       #=> ["config.h", "main.rb"]
Dir.glob("*", File::FNM_DOTMATCH)   #=> [".", "..", "config.h", "main.rb"]

rbfiles = File.join("**", "*.rb")
Dir.glob(rbfiles)                   #=> ["main.rb",
                                    #    "lib/song.rb",
                                    #    "lib/song/karaoke.rb"]
libdirs = File.join("**", "lib")
Dir.glob(libdirs)                   #=> ["lib"]

librbfiles = File.join("**", "lib", "**", "*.rb")
Dir.glob(librbfiles)                #=> ["lib/song.rb",
                                    #    "lib/song/karaoke.rb"]

librbfiles = File.join("**", "lib", "*.rb")
Dir.glob(librbfiles)                #=> ["lib/song.rb"]

Overloads:

.glob(pattern, [flags]) ⇒ Array
Returns:
- (Array)
.glob(pattern, [flags]) {|filename| ... } ⇒ nil
Yields:
- (filename)
Returns:
- (nil)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.glob( pattern, [flags] ) -> array
 *     Dir.glob( pattern, [flags] ) {| filename | block }  -> nil
 *
 *  Returns the filenames found by expanding <i>pattern</i> which is
 *  an +Array+ of the patterns or the pattern +String+, either as an
 *  <i>array</i> or as parameters to the block. Note that this pattern
 *  is not a regexp (it's closer to a shell glob). See
 *  <code>File::fnmatch</code> for the meaning of the <i>flags</i>
 *  parameter. Note that case sensitivity depends on your system (so
 *  <code>File::FNM_CASEFOLD</code> is ignored)
 *
 *  <code>*</code>::        Matches any file. Can be restricted by
 *                          other values in the glob. <code>*</code>
 *                          will match all files; <code>c*</code> will
 *                          match all files beginning with
 *                          <code>c</code>; <code>*c</code> will match
 *                          all files ending with <code>c</code>; and
 *                          <code>\*c\*</code> will match all files that
 *                          have <code>c</code> in them (including at
 *                          the beginning or end). Equivalent to
 *                          <code>/ .* /x</code> in regexp. Note, this
 *                          will not match Unix-like hidden files (dotfiles).
 *                          In order to include those in the match results,
 *                          you must use something like "{*,.*}".
 *  <code>**</code>::       Matches directories recursively.
 *  <code>?</code>::        Matches any one character. Equivalent to
 *                          <code>/.{1}/</code> in regexp.
 *  <code>[set]</code>::    Matches any one character in +set+.
 *                          Behaves exactly like character sets in
 *                          Regexp, including set negation
 *                          (<code>[^a-z]</code>).
 *  <code>{p,q}</code>::    Matches either literal <code>p</code> or
 *                          literal <code>q</code>. Matching literals
 *                          may be more than one character in length.
 *                          More than two literals may be specified.
 *                          Equivalent to pattern alternation in
 *                          regexp.
 *  <code>\</code>::        Escapes the next metacharacter.
 *                          Note that this means you cannot use backslash in windows
 *                          as part of a glob, i.e. Dir["c:\\foo*"] will not work
 *                          use Dir["c:/foo*"] instead
 *
 *     Dir["config.?"]                     #=> ["config.h"]
 *     Dir.glob("config.?")                #=> ["config.h"]
 *     Dir.glob("*.[a-z][a-z]")            #=> ["main.rb"]
 *     Dir.glob("*.[^r]*")                 #=> ["config.h"]
 *     Dir.glob("*.{rb,h}")                #=> ["main.rb", "config.h"]
 *     Dir.glob("*")                       #=> ["config.h", "main.rb"]
 *     Dir.glob("*", File::FNM_DOTMATCH)   #=> [".", "..", "config.h", "main.rb"]
 *
 *     rbfiles = File.join("**", "*.rb")
 *     Dir.glob(rbfiles)                   #=> ["main.rb",
 *                                         #    "lib/song.rb",
 *                                         #    "lib/song/karaoke.rb"]
 *     libdirs = File.join("**", "lib")
 *     Dir.glob(libdirs)                   #=> ["lib"]
 *
 *     librbfiles = File.join("**", "lib", "**", "*.rb")
 *     Dir.glob(librbfiles)                #=> ["lib/song.rb",
 *                                         #    "lib/song/karaoke.rb"]
 *
 *     librbfiles = File.join("**", "lib", "*.rb")
 *     Dir.glob(librbfiles)                #=> ["lib/song.rb"]
 */
static VALUE
dir_s_glob(int argc, VALUE *argv, VALUE obj)
{
    VALUE str, rflags, ary;
    int flags;

    if (rb_scan_args(argc, argv, "11", &str, &rflags) == 2)
    flags = NUM2INT(rflags);
    else
    flags = 0;

    ary = rb_check_array_type(str);
    if (NIL_P(ary)) {
    ary = rb_push_glob(str, flags);
    }
    else {
    volatile VALUE v = ary;
    ary = dir_globs(RARRAY_LEN(v), RARRAY_PTR(v), flags);
    }

    if (rb_block_given_p()) {
    rb_ary_each(ary);
    return Qnil;
    }
    return ary;
}

.home ⇒ `Object` .home("root") ⇒ `Object`

Returns the home directory of the current user or the named user if given.

# File 'dir.c'

/*
 *  call-seq:
 *    Dir.home()       -> "/home/me"
 *    Dir.home("root") -> "/root"
 *
 *  Returns the home directory of the current user or the named user
 *  if given.
 */
static VALUE
dir_s_home(int argc, VALUE *argv, VALUE obj)
{
    VALUE user;
    const char *u = 0;

    rb_scan_args(argc, argv, "01", &user);
    if (!NIL_P(user)) {
    SafeStringValue(user);
    u = StringValueCStr(user);
    }
    return rb_home_dir(u, rb_str_new(0, 0));
}

.mkdir(string[, integer]) ⇒ `0`

Makes a new directory named by string, with permissions specified by the optional parameter anInteger. The permissions may be modified by the value of File::umask, and are ignored on NT. Raises a SystemCallError if the directory cannot be created. See also the discussion of permissions in the class documentation for File.

Returns:

(0)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.mkdir( string [, integer] ) -> 0
 *
 *  Makes a new directory named by <i>string</i>, with permissions
 *  specified by the optional parameter <i>anInteger</i>. The
 *  permissions may be modified by the value of
 *  <code>File::umask</code>, and are ignored on NT. Raises a
 *  <code>SystemCallError</code> if the directory cannot be created. See
 *  also the discussion of permissions in the class documentation for
 *  <code>File</code>.
 *
 */
static VALUE
dir_s_mkdir(int argc, VALUE *argv, VALUE obj)
{
    VALUE path, vmode;
    int mode;

    if (rb_scan_args(argc, argv, "11", &path, &vmode) == 2) {
    mode = NUM2INT(vmode);
    }
    else {
    mode = 0777;
    }

    check_dirname(&path);
    path = rb_str_encode_ospath(path);
    if (mkdir(RSTRING_PTR(path), mode) == -1)
    rb_sys_fail(RSTRING_PTR(path));

    return INT2FIX(0);
}

.open(string) ⇒ `Dir` .open(string) {|aDir| ... } ⇒ `Object`

With no block, open is a synonym for Dir::new. If a block is present, it is passed aDir as a parameter. The directory is closed at the end of the block, and Dir::open returns the value of the block.

Overloads:

.open(string) ⇒ Dir
Returns:
- (Dir)
.open(string) {|aDir| ... } ⇒ Object
Yields:
- (aDir)
Returns:
- (Object)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.open( string ) -> aDir
 *     Dir.open( string ) {| aDir | block } -> anObject
 *
 *  With no block, <code>open</code> is a synonym for
 *  <code>Dir::new</code>. If a block is present, it is passed
 *  <i>aDir</i> as a parameter. The directory is closed at the end of
 *  the block, and <code>Dir::open</code> returns the value of the
 *  block.
 */
static VALUE
dir_s_open(int argc, VALUE *argv, VALUE klass)
{
    struct dir_data *dp;
    VALUE dir = TypedData_Make_Struct(klass, struct dir_data, &dir_data_type, dp);

    dir_initialize(argc, argv, dir);
    if (rb_block_given_p()) {
    return rb_ensure(rb_yield, dir, dir_close, dir);
    }

    return dir;
}

.getwd ⇒ `String` .pwd ⇒ `String`

Returns the path to the current working directory of this process as a string.

Dir.chdir("/tmp")   #=> 0
Dir.getwd           #=> "/tmp"

Overloads:

.getwd ⇒ String
Returns:
- (String)
.pwd ⇒ String
Returns:
- (String)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.getwd -> string
 *     Dir.pwd -> string
 *
 *  Returns the path to the current working directory of this process as
 *  a string.
 *
 *     Dir.chdir("/tmp")   #=> 0
 *     Dir.getwd           #=> "/tmp"
 */
static VALUE
dir_s_getwd(VALUE dir)
{
    return rb_dir_getwd();
}

.delete(string) ⇒ `0` .rmdir(string) ⇒ `0` .unlink(string) ⇒ `0`

Deletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty.

Overloads:

.delete(string) ⇒ 0
Returns:
- (0)
.rmdir(string) ⇒ 0
Returns:
- (0)
.unlink(string) ⇒ 0
Returns:
- (0)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.delete( string ) -> 0
 *     Dir.rmdir( string ) -> 0
 *     Dir.unlink( string ) -> 0
 *
 *  Deletes the named directory. Raises a subclass of
 *  <code>SystemCallError</code> if the directory isn't empty.
 */
static VALUE
dir_s_rmdir(VALUE obj, VALUE dir)
{
    check_dirname(&dir);
    dir = rb_str_encode_ospath(dir);
    if (rmdir(RSTRING_PTR(dir)) < 0)
    rb_sys_fail(RSTRING_PTR(dir));

    return INT2FIX(0);
}

.delete(string) ⇒ `0` .rmdir(string) ⇒ `0` .unlink(string) ⇒ `0`

Deletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty.

Overloads:

.delete(string) ⇒ 0
Returns:
- (0)
.rmdir(string) ⇒ 0
Returns:
- (0)
.unlink(string) ⇒ 0
Returns:
- (0)

# File 'dir.c'

/*
 *  call-seq:
 *     Dir.delete( string ) -> 0
 *     Dir.rmdir( string ) -> 0
 *     Dir.unlink( string ) -> 0
 *
 *  Deletes the named directory. Raises a subclass of
 *  <code>SystemCallError</code> if the directory isn't empty.
 */
static VALUE
dir_s_rmdir(VALUE obj, VALUE dir)
{
    check_dirname(&dir);
    dir = rb_str_encode_ospath(dir);
    if (rmdir(RSTRING_PTR(dir)) < 0)
    rb_sys_fail(RSTRING_PTR(dir));

    return INT2FIX(0);
}

Instance Method Details

#close ⇒ `nil`

Closes the directory stream. Any further attempts to access dir will raise an IOError.

d = Dir.new("testdir")
d.close   #=> nil

Returns:

(nil)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.close -> nil
 *
 *  Closes the directory stream. Any further attempts to access
 *  <em>dir</em> will raise an <code>IOError</code>.
 *
 *     d = Dir.new("testdir")
 *     d.close   #=> nil
 */
static VALUE
dir_close(VALUE dir)
{
    struct dir_data *dirp;

    GetDIR(dir, dirp);
    closedir(dirp->dir);
    dirp->dir = NULL;

    return Qnil;
}

#each {|filename| ... } ⇒ `Dir` #each ⇒ `Object`

Calls the block once for each entry in this directory, passing the filename of each entry as a parameter to the block.

If no block is given, an enumerator is returned instead.

d = Dir.new("testdir")
d.each  {|x| puts "Got #{x}" }

produces:

Got .
Got ..
Got config.h
Got main.rb

Overloads:

#each {|filename| ... } ⇒ Dir
Yields:
- (filename)
Returns:
- (Dir)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.each { |filename| block }  -> dir
 *     dir.each                       -> an_enumerator
 *
 *  Calls the block once for each entry in this directory, passing the
 *  filename of each entry as a parameter to the block.
 *
 *  If no block is given, an enumerator is returned instead.
 *
 *     d = Dir.new("testdir")
 *     d.each  {|x| puts "Got #{x}" }
 *
 *  <em>produces:</em>
 *
 *     Got .
 *     Got ..
 *     Got config.h
 *     Got main.rb
 */
static VALUE
dir_each(VALUE dir)
{
    struct dir_data *dirp;
    struct dirent *dp;
    IF_HAVE_READDIR_R(DEFINE_STRUCT_DIRENT entry);

    RETURN_ENUMERATOR(dir, 0, 0);
    GetDIR(dir, dirp);
    rewinddir(dirp->dir);
    while (READDIR(dirp->dir, dirp->enc, &STRUCT_DIRENT(entry), dp)) {
    rb_yield(rb_external_str_new_with_enc(dp->d_name, NAMLEN(dp), dirp->enc));
    if (dirp->dir == NULL) dir_closed();
    }
    return dir;
}

#inspect ⇒ `String`

Return a string describing this Dir object.

Returns:

(String)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.inspect -> string
 *
 *  Return a string describing this Dir object.
 */
static VALUE
dir_inspect(VALUE dir)
{
    struct dir_data *dirp;

    TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dirp);
    if (!NIL_P(dirp->path)) {
    const char *c = rb_obj_classname(dir);
    return rb_sprintf("#<%s:%s>", c, RSTRING_PTR(dirp->path));
    }
    return rb_funcall(dir, rb_intern("to_s"), 0, 0);
}

#path ⇒ `String`^?

Returns the path parameter passed to dir's constructor.

d = Dir.new("..")
d.path   #=> ".."

Returns:

(String, nil)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.path -> string or nil
 *
 *  Returns the path parameter passed to <em>dir</em>'s constructor.
 *
 *     d = Dir.new("..")
 *     d.path   #=> ".."
 */
static VALUE
dir_path(VALUE dir)
{
    struct dir_data *dirp;

    TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dirp);
    if (NIL_P(dirp->path)) return Qnil;
    return rb_str_dup(dirp->path);
}

#pos ⇒ `Integer` #tell ⇒ `Integer`

Returns the current position in dir. See also Dir#seek.

d = Dir.new("testdir")
d.tell   #=> 0
d.read   #=> "."
d.tell   #=> 12

Overloads:

#pos ⇒ Integer
Returns:
- (Integer)
#tell ⇒ Integer
Returns:
- (Integer)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.pos -> integer
 *     dir.tell -> integer
 *
 *  Returns the current position in <em>dir</em>. See also
 *  <code>Dir#seek</code>.
 *
 *     d = Dir.new("testdir")
 *     d.tell   #=> 0
 *     d.read   #=> "."
 *     d.tell   #=> 12
 */
static VALUE
dir_tell(VALUE dir)
{
    struct dir_data *dirp;
    long pos;

    GetDIR(dir, dirp);
    pos = telldir(dirp->dir);
    return rb_int2inum(pos);
}

#pos(integer) ⇒ `Integer`

Synonym for Dir#seek, but returns the position parameter.

d = Dir.new("testdir")   #=> #<Dir:0x401b3c40>
d.read                   #=> "."
i = d.pos                #=> 12
d.read                   #=> ".."
d.pos = i                #=> 12
d.read                   #=> ".."

Returns:

(Integer)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.pos( integer ) -> integer
 *
 *  Synonym for <code>Dir#seek</code>, but returns the position
 *  parameter.
 *
 *     d = Dir.new("testdir")   #=> #<Dir:0x401b3c40>
 *     d.read                   #=> "."
 *     i = d.pos                #=> 12
 *     d.read                   #=> ".."
 *     d.pos = i                #=> 12
 *     d.read                   #=> ".."
 */
static VALUE
dir_set_pos(VALUE dir, VALUE pos)
{
    dir_seek(dir, pos);
    return pos;
}

#read ⇒ `String`^?

Reads the next entry from dir and returns it as a string. Returns nil at the end of the stream.

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

Returns:

(String, nil)

# File 'dir.c'

/*
 *  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(VALUE dir)
{
    struct dir_data *dirp;
    struct dirent *dp;
    IF_HAVE_READDIR_R(DEFINE_STRUCT_DIRENT entry);

    GetDIR(dir, dirp);
    errno = 0;
    if (READDIR(dirp->dir, dirp->enc, &STRUCT_DIRENT(entry), dp)) {
    return rb_external_str_new_with_enc(dp->d_name, NAMLEN(dp), dirp->enc);
    }
    else if (errno == 0) {  /* end of stream */
    return Qnil;
    }
    else {
    rb_sys_fail(0);
    }
    return Qnil;        /* not reached */
}

#rewind ⇒ `Dir`

Repositions dir to the first entry.

d = Dir.new("testdir")
d.read     #=> "."
d.rewind   #=> #<Dir:0x401b3fb0>
d.read     #=> "."

Returns:

(Dir)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.rewind -> dir
 *
 *  Repositions <em>dir</em> to the first entry.
 *
 *     d = Dir.new("testdir")
 *     d.read     #=> "."
 *     d.rewind   #=> #<Dir:0x401b3fb0>
 *     d.read     #=> "."
 */
static VALUE
dir_rewind(VALUE dir)
{
    struct dir_data *dirp;

    if (rb_safe_level() >= 4 && !OBJ_UNTRUSTED(dir)) {
    rb_raise(rb_eSecurityError, "Insecure: can't close");
    }
    GetDIR(dir, dirp);
    rewinddir(dirp->dir);
    return dir;
}

#seek(integer) ⇒ `Dir`

Seeks to a particular location in dir. integer must be a value returned by Dir#tell.

d = Dir.new("testdir")   #=> #<Dir:0x401b3c40>
d.read                   #=> "."
i = d.tell               #=> 12
d.read                   #=> ".."
d.seek(i)                #=> #<Dir:0x401b3c40>
d.read                   #=> ".."

Returns:

(Dir)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.seek( integer ) -> dir
 *
 *  Seeks to a particular location in <em>dir</em>. <i>integer</i>
 *  must be a value returned by <code>Dir#tell</code>.
 *
 *     d = Dir.new("testdir")   #=> #<Dir:0x401b3c40>
 *     d.read                   #=> "."
 *     i = d.tell               #=> 12
 *     d.read                   #=> ".."
 *     d.seek(i)                #=> #<Dir:0x401b3c40>
 *     d.read                   #=> ".."
 */
static VALUE
dir_seek(VALUE dir, VALUE pos)
{
    struct dir_data *dirp;
    long p = NUM2LONG(pos);

    GetDIR(dir, dirp);
    seekdir(dirp->dir, p);
    return dir;
}

#pos ⇒ `Integer` #tell ⇒ `Integer`

Returns the current position in dir. See also Dir#seek.

d = Dir.new("testdir")
d.tell   #=> 0
d.read   #=> "."
d.tell   #=> 12

Overloads:

#pos ⇒ Integer
Returns:
- (Integer)
#tell ⇒ Integer
Returns:
- (Integer)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.pos -> integer
 *     dir.tell -> integer
 *
 *  Returns the current position in <em>dir</em>. See also
 *  <code>Dir#seek</code>.
 *
 *     d = Dir.new("testdir")
 *     d.tell   #=> 0
 *     d.read   #=> "."
 *     d.tell   #=> 12
 */
static VALUE
dir_tell(VALUE dir)
{
    struct dir_data *dirp;
    long pos;

    GetDIR(dir, dirp);
    pos = telldir(dirp->dir);
    return rb_int2inum(pos);
}

#path ⇒ `String`^?

Returns the path parameter passed to dir's constructor.

d = Dir.new("..")
d.path   #=> ".."

Returns:

(String, nil)

# File 'dir.c'

/*
 *  call-seq:
 *     dir.path -> string or nil
 *
 *  Returns the path parameter passed to <em>dir</em>'s constructor.
 *
 *     d = Dir.new("..")
 *     d.path   #=> ".."
 */
static VALUE
dir_path(VALUE dir)
{
    struct dir_data *dirp;

    TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dirp);
    if (NIL_P(dirp->path)) return Qnil;
    return rb_str_dup(dirp->path);
}

Class: Dir

Overview

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

Constructor Details

#new(string) ⇒ Dir

Class Method Details

.[](array) ⇒ Array .[](string[, string ...)) ⇒ Array

.chdir([ string]) ⇒ 0 .chdir([ string]) {|path| ... } ⇒ Object

.chroot(string) ⇒ 0

.delete(string) ⇒ 0 .rmdir(string) ⇒ 0 .unlink(string) ⇒ 0

.entries(dirname) ⇒ Array

.exist? ⇒ Object

.exists? ⇒ Object

.foreach(dirname) {|filename| ... } ⇒ nil .foreach(dirname) ⇒ Object

.getwd ⇒ String .pwd ⇒ String

.glob(pattern, [flags]) ⇒ Array .glob(pattern, [flags]) {|filename| ... } ⇒ nil

.home ⇒ Object .home("root") ⇒ Object

.mkdir(string[, integer]) ⇒ 0

.open(string) ⇒ Dir .open(string) {|aDir| ... } ⇒ Object

.getwd ⇒ String .pwd ⇒ String

.delete(string) ⇒ 0 .rmdir(string) ⇒ 0 .unlink(string) ⇒ 0

.delete(string) ⇒ 0 .rmdir(string) ⇒ 0 .unlink(string) ⇒ 0

Instance Method Details

#close ⇒ nil

#each {|filename| ... } ⇒ Dir #each ⇒ Object

#inspect ⇒ String

#path ⇒ String?

#pos ⇒ Integer #tell ⇒ Integer

#pos(integer) ⇒ Integer

#read ⇒ String?

#rewind ⇒ Dir

#seek(integer) ⇒ Dir

#pos ⇒ Integer #tell ⇒ Integer

#path ⇒ String?

#new(string) ⇒ `Dir`

.[](array) ⇒ `Array` .[](string[, string ...)) ⇒ `Array`

.chdir([ string]) ⇒ `0` .chdir([ string]) {|path| ... } ⇒ `Object`

.chroot(string) ⇒ `0`

.delete(string) ⇒ `0` .rmdir(string) ⇒ `0` .unlink(string) ⇒ `0`

.entries(dirname) ⇒ `Array`

.exist? ⇒ `Object`

.exists? ⇒ `Object`

.foreach(dirname) {|filename| ... } ⇒ `nil` .foreach(dirname) ⇒ `Object`

.getwd ⇒ `String` .pwd ⇒ `String`

.glob(pattern, [flags]) ⇒ `Array` .glob(pattern, [flags]) {|filename| ... } ⇒ `nil`

.home ⇒ `Object` .home("root") ⇒ `Object`

.mkdir(string[, integer]) ⇒ `0`

.open(string) ⇒ `Dir` .open(string) {|aDir| ... } ⇒ `Object`

.getwd ⇒ `String` .pwd ⇒ `String`

.delete(string) ⇒ `0` .rmdir(string) ⇒ `0` .unlink(string) ⇒ `0`

.delete(string) ⇒ `0` .rmdir(string) ⇒ `0` .unlink(string) ⇒ `0`

#close ⇒ `nil`

#each {|filename| ... } ⇒ `Dir` #each ⇒ `Object`

#inspect ⇒ `String`

#path ⇒ `String`^?

#pos ⇒ `Integer` #tell ⇒ `Integer`

#pos(integer) ⇒ `Integer`

#read ⇒ `String`^?

#rewind ⇒ `Dir`

#seek(integer) ⇒ `Dir`

#pos ⇒ `Integer` #tell ⇒ `Integer`

#path ⇒ `String`^?