Dir

class Dir

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 (-)-

Included Modules

Enumerable(String)
Iterable(String)

Defined in:

dir.cr
dir/glob.cr

Class Method Summary

.[](*patterns) : Array(String)
.[](patterns : Enumerable(String)) : Array(String)
.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.
.current : String
Returns the current working directory.
.empty?(path) : Bool
Returns true if the directory at path is empty, otherwise returns false.
.entries(dirname) : Array(String)
Returns an array containing all of the filenames in the given directory.
.exists?(path) : Bool
Returns true if the given path exists and is a directory
.foreach(dirname, &block)
Calls the block once for each entry in the named directory, passing the filename of each entry as a parameter to the block.
.glob(patterns : Enumerable(String), &block)
.glob(*patterns) : Array(String)
.glob(patterns : Enumerable(String)) : Array(String)
.glob(*patterns, &block)
.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.
.new(path)
Returns a new directory object for the named directory.
.open(path, &block)
Opens a directory and yields it, closing it at the end of the block.
.open(path) : self
Alias for .new(path)
.rmdir(path)
Removes the directory at the given path.

Instance Method Summary

#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
#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)

Instance methods inherited from module `Iterable(String)`

, , , , , ,

Instance methods inherited from module `Enumerable(String)`

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Instance methods inherited from class `Reference`

, , , , , , ,

Class methods inherited from class `Reference`

Instance methods inherited from class `Object`

, , , , , , , , , , , , , , , , , ,

Class methods inherited from class `Object`

Class Method Detail

def self.[](*patterns) : Array(String)Source

def self.[](patterns : Enumerable(String)) : Array(String)Source

def self.cd(path)Source

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

def self.cd(path, &block)Source

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.

def self.current : String Source

Returns the current working directory.

def self.empty?(path) : Bool Source

Returns true if the directory at path is empty, otherwise returns false. Raises Errno if the directory at path does not exist-

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

def self.entries(dirname) : Array(String)Source

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

def self.exists?(path) : Bool Source

Returns true if the given path exists and is a directory

def self.foreach(dirname, &block)Source

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

def self.glob(patterns : Enumerable(String), &block)Source

def self.glob(*patterns) : Array(String)Source

def self.glob(patterns : Enumerable(String)) : Array(String)Source

def self.glob(*patterns, &block)Source

def self.mkdir(path, mode = 511)Source

Creates a new directory at the given path. The linux-style permission mode can be specified, with a default of 777 (0o777).

def self.mkdir_p(path, mode = 511)Source

Creates a new directory at the given path, including any non-existing intermediate directories. The linux-style permission mode can be specified, with a default of 777 (0o777).

def self.new(path)Source

Returns a new directory object for the named directory.

def self.open(path, &block)Source

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

def self.open(path) : selfSource

Alias for .new(path)

def self.rmdir(path)Source

Removes the directory at the given path.

Instance Method Detail

def closeSource

Closes the directory stream.

def each(&block) : Nil Source

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

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

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

produces:

Got .
Got ..
Got config.h

def eachSource

def inspect(io)Source

def path : String Source

def pretty_print(pp)Source

def readSource

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

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

def rewindSource

Repositions this directory to the first entry.

def to_s(io)Source

© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/Dir.html

Dir