Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > fileutilsライブラリ > FileUtilsモジュール

module FileUtils

クラス・モジュールの継承リスト: FileUtils

要約

基本的なファイル操作を集めたモジュールです。

オプションの説明

引数 options で使用できるオプションの説明です。メソッドごとに使用できるオプションは決まっています。不正なオプションを与えると ArgumentError が発生します。

:noop

真を指定すると実際の処理は行いません。

:preserve

真を指定すると更新時刻と、可能なら所有ユーザ・所有グループもコピーします。

:verbose

真を指定すると詳細を出力します。

:mode

パーミッションを8進数で指定します。

:force

真を指定すると作業中すべての StandardError を無視します。

:nocreate

真を指定するとファイルを作成しません。

:dereference_root

真を指定すると src についてだけシンボリックリンクの指す内容をコピーします。偽の場合はシンボリックリンク自体をコピーします。

:remove_destination

真を指定するとコピーを実行する前にコピー先を削除します。

:secure

真を指定するとファイルの削除に FileUtils.#remove_entry_secure を使用します。

:mtime

時刻を Time か、起算時からの経過秒数を数値で指定します。

:parents

真を指定すると指定したディレクトリの親ディレクトリも含めて削除します。

特異メソッド

定義 説明
collect_method(opt) -> Array

与えられたオプションを持つメソッド名の配列を返します。

commands -> Array

何らかのオプションを持つメソッド名の配列を返します。

have_option?(mid, opt) -> bool

mid というメソッドが opt というオプションを持つ場合、真を返します。そうでない場合は、偽を返します。

options -> Array

オプション名の配列を返します。

options_of(mid) -> Array

与えられたメソッド名で使用可能なオプション名の配列を返します。

モジュール関数

定義 説明
cd(dir, options = {}) -> nil
cd(dir, options = {}) {|dir| .... } -> nil
chdir(dir, options = {}) -> nil
chdir(dir, options = {}) {|dir| .... } -> nil

プロセスのカレントディレクトリを dir に変更します。

chmod(mode, list, options = {}) -> Array

ファイル list のパーミッションを mode に変更します。

chmod_R(mode, list, options = {}) -> Array

ファイル list のパーミッションを再帰的に mode へ変更します。

chown(user, group, list, options = {}) -> Array

ファイル list の所有ユーザと所有グループを user と group に変更します。

chown_R(user, group, list, options = {}) -> Array

list 以下のファイルの所有ユーザと所有グループを user と group へ再帰的に変更します。

cmp(file_a, file_b) -> bool
compare_file(file_a, file_b) -> bool
identical?(file_a, file_b) -> bool

ファイル file_a と file_b の内容が同じなら真を返します。

compare_stream(io_a, io_b) -> bool

IO オブジェクト io_a と io_b の内容が同じなら真を返します。

cp(src, dest, options = {}) -> ()
copy(src, dest, options = {}) -> ()

ファイル src を dest にコピーします。

copy_entry(src, dest, preserve = false, dereference_root = false) -> ()

ファイル src を dest にコピーします。

copy_file(src, dest, preserve = false, dereference_root = true) -> ()

ファイル src の内容を dest にコピーします。

copy_stream(src, dest) -> ()

src を dest にコピーします。 src には read メソッド、dest には write メソッドが必要です。

cp_r(src, dest, options = {}) -> ()

src を dest にコピーします。src がディレクトリであったら再帰的にコピーします。その際 dest がディレクトリなら dest/src にコピーします。

pwd -> String
getwd -> String

プロセスのカレントディレクトリを文字列で返します。

install(src, dest, options = {}) -> ()

src と dest の内容が違うときだけ src を dest にコピーします。

ln(src, dest, options = {}) -> ()
link(src, dest, options = {}) -> ()

src へのハードリンク dest を作成します。

ln_s(src, dest, options = {}) -> ()
symlink(src, dest, options = {}) -> ()

src へのシンボリックリンク dest を作成します。

ln_sf(src, dest, options = {}) -> ()

src へのシンボリックリンク dest を作成します。

mkdir_p(list, options = {}) -> Array
mkpath(list, options = {}) -> Array
makedirs(list, options = {}) -> Array

ディレクトリ dir とその親ディレクトリを全て作成します。

mkdir(dir, options = {}) -> ()

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

mv(src, dest, options = {}) -> ()
move(src, dest, options = {}) -> ()

ファイル src を dest に移動します。

rm(list, options = {}) -> ()
remove(list, options = {}) -> ()

list で指定された対象を消去します。

remove_dir(path, force = false) -> ()

ディレクトリ path を削除します。

remove_entry(path, force = false) -> ()

ファイル path を削除します。path がディレクトリなら再帰的に削除します。

remove_entry_secure(path, force = false) -> ()

ファイル path を削除します。path がディレクトリなら再帰的に削除します。

remove_file(path, force = false) -> ()

ファイル path を削除します。

rm_f(list, options = {}) -> ()
safe_unlink(list, options = {}) -> ()

FileUtils.rm(list, force: true) と同じです。

rm_r(list, options = {}) -> ()

ファイルまたはディレクトリ list を再帰的に消去します。

rm_rf(list, options = {}) -> ()
rmtree(list, options = {}) -> ()

ファイルまたはディレクトリ list を再帰的に消去します。

rmdir(dir, options = {}) -> ()

ディレクトリ dir を削除します。

touch(list, options = {}) -> ()

list で指定されたファイルの最終変更時刻 (mtime) とアクセス時刻 (atime) を変更します。

uptodate?(newer, older_list, options = nil) -> bool

newer が、older_list に含まれるすべてのファイルより新しいとき真。存在しないファイルは無限に古いとみなされます。

定数

定義 説明
METHODS -> Array

このモジュールで定義されている公開メソッドの配列を返します。

OPT_TABLE -> Hash

内部で使用します。

追加されるメソッド

定義 説明 ライブラリ
ruby(*args) {|result, status| ... }

与えられた引数で Ruby インタプリタを実行します。

rake
safe_ln(*args)

安全にリンクを作成します。

rake
sh(*cmd) {|result, status| ... }

与えられたコマンドを実行します。

rake
split_all(path) -> Array

与えられたパスをディレクトリごとに分割します。

rake