class Dir

• Dir
• Reference
• Object

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.

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

See also: File.

Included Modules

• Enumerable(String)
• Iterable(String)

Defined in:

Constructors

• .new(path)

  Returns a new directory object for the named directory.

• .open(path) : self

  Alias for new(path)

Class Method Summary

• .[](*patterns) : Array(String)

  Returns an array of all files that match against any of patterns.

• .[](patterns : Enumerable(String)) : Array(String)

  Returns an array of all files that match against any of patterns.

• .cd(path)

  Changes the current working directory of the process to the given string.

• .cd(path, &block)

  Changes the current working directory of the process to the given string and invokes the block, restoring the original working directory when the block exits.

• .children(dirname) : Array(String)

  See #children.

• .current : String

  Returns the current working directory.

• .each(dirname, &block)

  See #each.

• .each_child(dirname, &block)

  See #each_child.

• .empty?(path) : Bool

  Returns true if the directory at path is empty, otherwise returns false.

• .entries(dirname) : Array(String)

  See #entries.

• .exists?(path) : Bool

  Returns true if the given path exists and is a directory

• .glob(patterns : Enumerable(String), match_hidden = false, &block : String -> UNDERSCORE)

  Yields all files that match against any of patterns.

• .glob(*patterns, match_hidden = false) : Array(String)

  Returns an array of all files that match against any of patterns.

• .glob(patterns : Enumerable(String), match_hidden = false) : Array(String)

  Returns an array of all files that match against any of patterns.

• .glob(*patterns, match_hidden = false, &block : String -> UNDERSCORE)

  Yields all files that match against any of patterns.

• .mkdir(path, mode = 511)

  Creates a new directory at the given path.

• .mkdir_p(path, mode = 511)

  Creates a new directory at the given path, including any non-existing intermediate directories.

• .open(path, &block)

  Opens a directory and yields it, closing it at the end of the block.

• .rmdir(path)

  Removes the directory at the given path.

• .tempdir : String

  Returns the tmp dir used for tempfile.

Instance Method Summary

• #children : Array(String)

  Returns an array containing all of the filenames except for . and .. in the given directory.

• #close

  Closes the directory stream.

• #each(&block) : Nil

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

• #each
• #each_child(&block) : Nil

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

• #each_child
• #entries : Array(String)

  Returns an array containing all of the filenames in the given directory.

• #inspect(io)
• #path : String
• #pretty_print(pp)
• #read

  Reads the next entry from dir and returns it as a string.

• #rewind

  Repositions this directory to the first entry.

• #to_s(io)

Constructor Detail

Class Method Detail

Dir.mkdir("bar")
Dir.empty?("bar") # => true
File.write("bar/a_file", "The content")
Dir.empty?("bar") # => false

Dir.tempdir # => "/tmp"

Instance Method Detail

Dir.mkdir("testdir")
File.write("testdir/config.h", "")

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

Got .
Got ..
Got config.h

Dir.mkdir("testdir")
File.write("testdir/config.h", "")

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

Got config.h

d = Dir.new("testdir")
array = [] of String
while file = d.read
  array << file
end
array.sort # => [".", "..", "config.h"]