Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Dirクラス

class Dir

クラス・モジュールの継承リスト: Dir < Enumerable < Object < Kernel < BasicObject

要約

ディレクトリの操作を行うためのクラスです。

特異メソッド

定義 説明
self[*pattern] -> [String]
glob(pattern, flags = 0) -> [String]
glob(pattern, flags = 0) {|file| ...} -> nil

ワイルドカードの展開を行い、パターンにマッチするファイル名を文字列の配列として返します。パターンにマッチするファイルがない場合は空の配列を返します。

chdir -> 0
chdir(path) -> 0
chdir {|path| ... } -> object
chdir(path) {|path| ... } -> object

カレントディレクトリを path に変更します。

chroot(path) -> 0

ルートディレクトリを path に変更します。

delete(path) -> 0
rmdir(path) -> 0
unlink(path) -> 0

ディレクトリを削除します。ディレクトリは空でなければいけません。ディレクトリの削除に成功すれば 0 を返します。

entries(path) -> [String]
entries(path, encoding: Encoding.find("filesystem")) -> [String]

ディレクトリ path に含まれるファイルエントリ名の配列を返します。

exist?(file_name) -> bool

file_name で与えられたディレクトリが存在する場合に真を返します。そうでない場合は、偽を返します。

exists?(file_name) -> bool

このメソッドは Ruby 2.1 から deprecated です。Dir.exist? を使用してください。

foreach(path) {|file| ...} -> nil
foreach(path, encoding: Encoding.find("filesystem")) {|file| ...} -> nil
foreach(path) -> Enumerator
foreach(path, encoding: Encoding.find("filesystem")) -> Enumerator

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

getwd -> String
pwd -> String

カレントディレクトリのフルパスを文字列で返します。

home -> String | nil
home(user) -> String | nil

現在のユーザまたは指定されたユーザのホームディレクトリを返します。

mkdir(path, mode = 0777) -> 0

path で指定された新しいディレクトリを作ります。パーミッションは mode で指定された値に umask をかけた値 (mode & ~umask) になります。 mkdir(2) も参照して下さい。ディレクトリの作成に成功すれば 0 を返します。

new(path) -> Dir
new(path, encoding: Encoding.find("filesystem")) -> Dir
open(path) -> Dir
open(path, encoding: Encoding.find("filesystem")) -> Dir
open(path) {|dir| ...} -> object
open(path, encoding: Encoding.find("filesystem")) {|dir| ...} -> object

path に対するディレクトリストリームをオープンして返します。

インスタンスメソッド

定義 説明
close -> nil

ディレクトリストリームをクローズします。クローズに成功すれば nil を返します。

each {|item| ... } -> self
each -> Enumerator

ディレクトリの各エントリを表す文字列を引数として、ブロックを評価します。

fileno -> Integer

self に関連づけられたファイル記述子を表す整数を返します。

inspect -> String

self の情報を人間に読みやすい文字列にして返します。

path -> String
to_path -> String

オープンしているディレクトリのパス名を文字列で返します。

pos -> Integer
tell -> Integer

ディレクトリストリームの現在の位置を整数で返します。

pos=(pos)
seek(pos) -> self

ディレクトリストリームの読み込み位置を pos に移動させます。 pos は Dir#tell で与えられた値でなければなりません。

read -> String | nil

ディレクトリストリームから次の要素を読み出して返します。最後の要素まで読み出していれば nil を返します。

rewind -> self

ディレクトリストリームの読み込み位置を先頭に移動させます。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined all? any? chunk chunk_while collect collect_concat count cycle detect drop drop_while each_cons each_entry each_slice each_with_index each_with_object entries find_all find_index first grep grep_v group_by include? inject lazy max max_by min min_by minmax minmax_by none? one? partition reject reverse_each slice_after slice_before slice_when sort sort_by sum take take_while to_h to_set uniq zip !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE

追加されるメソッド

定義 説明 ライブラリ
mktmpdir(prefix_suffix = nil, tmpdir = nil) -> String
mktmpdir(prefix_suffix = nil, tmpdir = nil) {|dir| ... } -> object

一時ディレクトリを作成します。

tmpdir
tmpdir -> String

テンポラリファイルを作成するのに使うディレクトリ(テンポラリディレクトリ)の絶対パスを文字列として返します。 $SAFE によって返す文字列は変わります。

tmpdir