検索結果

Fiddle::CStruct.new(addr) -> Fiddle::CStruct (4.0)

• 2.5.0

• 特異メソッド

addr のアドレスが指すメモリを構造体のアドレスとみなし、 構造体を作ります。

addr のアドレスが指すメモリを構造体のアドレスとみなし、
構造体を作ります。

C におけるキャストと似ています。
return (struct foo*)addr;
というコードと対応していると言えます。

@param addr アドレス

• Fiddle::CStruct

Fiddle::CStruct.size -> Integer (4.0)

• 2.5.0

• 特異メソッド

構造体のサイズをバイト数で返します。

構造体のサイズをバイト数で返します。

このメソッドが返す値は C の構造体としてのサイズです。
Ruby のオブジェクトとしてはより大きなメモリを消費しています。

• Fiddle::CStruct

Fiddle::Closure.new(ret, args, abi=Fiddle::Function::DEFAULT) -> Fiddle::Closure (4.0)

• 2.5.0

• 特異メソッド

そのクラスの call メソッドを呼びだすような Fiddle::Closure オブジェクトを返します。

そのクラスの call メソッドを呼びだすような
Fiddle::Closure オブジェクトを返します。

args、ret で関数の引数と返り値の型を指定します。
指定は Fiddle::Function.new と同様なので、そちら
を参照してください。

@param ret 返り値の型
@param args 引数の型を表す配列
@param abi 呼出規約

• Fiddle::Closure

Fiddle::Closure::BlockCaller.new(ret, args, abi=Fiddle::Function::DEFAULT) { ... } -> Fiddle::Closure::BlockCaller (4.0)

• 2.5.0

• 特異メソッド

Ruby のブロックを呼び出す Fiddle::Closure オブジェクトを返します。

Ruby のブロックを呼び出す Fiddle::Closure オブジェクトを返します。


args、ret で関数の引数と返り値の型を指定します。
指定は Fiddle::Function.new と同様なので、そちら
を参照してください。

@param ret 返り値の型
@param args 引数の型を表す配列
@param abi 呼出規約

• Fiddle::Closure::BlockCaller

Fiddle::Function.new(ptr, args, ret_type, abi=Fiddle::Function::DEFAULT, name: nil) -> Fiddle::Function (4.0)

• 2.5.0

• 特異メソッド

ptr (関数ポインタ)から Fiddle::Function オブジェクトを 生成します。

ptr (関数ポインタ)から Fiddle::Function オブジェクトを
生成します。

ptr には Fiddle::Handle から Fiddle::Handle#sym などで取りだした
関数ポインタ(を表す整数)、もしくは関数を指している
Fiddle::Pointer を渡します。

args、ret_type で関数の引数と返り値の型を指定します。これには以下の
定数が利用できます。「-TYPE_INT」 のように符号を反転させると unsigned を
意味します。
* Fiddle::TYPE_VOID
* Fiddle::TYPE_VOIDP
* Fidd...

• Fiddle::Function
• Fiddle::Handle
• Fiddle::Pointer

絞り込み条件を変える

Fiddle::Handle.[](func) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ライブラリのデフォルトの検索順序に従い、現在のライブラリ以降の シンボルを探します。

ライブラリのデフォルトの検索順序に従い、現在のライブラリ以降の
シンボルを探します。

Fiddle::Handle::NEXT.sym(func) と同じです。詳しくは dlsym(3) の
RTLD_NEXT を見てください。

@raise Fiddle::DLError シンボルが見つからなかった時に発生します。

• Fiddle::Handle

Fiddle::Handle.new(lib, flags=Fiddle::Handle::RTLD_LAZY|Fiddle::Handle::RTLD_GLOBAL) -> Fiddle::Handle (4.0)

• 2.5.0

• 特異メソッド

ライブラリ lib をオープンし、Handle オブジェクトとして返します。

ライブラリ lib をオープンし、Handle オブジェクトとして返します。

ブロックを指定すれば、生成した Handle を引数としてブロックを実行します。
Handle はブロックの終りで自動的にクローズされます。

flags で dlopen(3) の第2引数として渡すフラグを指定できます。
Fiddle::Handle::RTLD_LAZY、Fiddle::Handle::RTLD_NOW
のどちらか一方を指定する必要があり、
またそれに Fiddle::Handle::RTLD_GLOBAL と OR を取ることができます。
詳しい意味は manpage(dlopen(3))...

• Fiddle::Handle

Fiddle::Handle.new(lib, flags=Fiddle::Handle::RTLD_LAZY|Fiddle::Handle::RTLD_GLOBAL) {|handle| ... } -> Fiddle::Handle (4.0)

• 2.5.0

• 特異メソッド

ライブラリ lib をオープンし、Handle オブジェクトとして返します。

ライブラリ lib をオープンし、Handle オブジェクトとして返します。

ブロックを指定すれば、生成した Handle を引数としてブロックを実行します。
Handle はブロックの終りで自動的にクローズされます。

flags で dlopen(3) の第2引数として渡すフラグを指定できます。
Fiddle::Handle::RTLD_LAZY、Fiddle::Handle::RTLD_NOW
のどちらか一方を指定する必要があり、
またそれに Fiddle::Handle::RTLD_GLOBAL と OR を取ることができます。
詳しい意味は manpage(dlopen(3))...

• Fiddle::Handle

Fiddle::Handle.sym(func) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ライブラリのデフォルトの検索順序に従い、現在のライブラリ以降の シンボルを探します。

ライブラリのデフォルトの検索順序に従い、現在のライブラリ以降の
シンボルを探します。

Fiddle::Handle::NEXT.sym(func) と同じです。詳しくは dlsym(3) の
RTLD_NEXT を見てください。

@raise Fiddle::DLError シンボルが見つからなかった時に発生します。

• Fiddle::Handle

Fiddle::Pointer.[](val) -> Fiddle::Pointer (4.0)

• 2.5.0

• 特異メソッド

与えられた val と関連した Pointer オブジェクトを生成して返します。

与えられた val と関連した Pointer オブジェクトを生成して返します。

val が文字列の場合は文字列が格納されているメモリ領域を指す Pointer
オブジェクトを返します。

IO オブジェクトの場合は FILE ポインタを表す Pointer オブジェクトを返します。

val に to_ptr メソッドが定義されている場合は、val.to_ptr を呼び、
Pointer オブジェクトに変換したものを返します。

val が整数の場合はそれをアドレスとする Pointer オブジェクトを返します。

上以外の場合は、整数に変換(to_int)し
それをアドレスとする P...

• Fiddle::Pointer

絞り込み条件を変える

Fiddle::Pointer.malloc(size, free = nil) -> Fiddle::Pointer (4.0)

• 2.5.0

• 特異メソッド

与えられた長さ size のメモリ領域を確保し、それを表す Pointer オブジェクトを生成して返します。

与えられた長さ size のメモリ領域を確保し、それを表す Pointer オブジェクトを生成して返します。

@param size 確保したいメモリ領域のサイズを整数で指定します。

@param free GC 時に呼ばれる Pointer オブジェクトの free 関数を
Fiddle::Function オブジェクトか整数で指定します。

• Fiddle::Pointer

Fiddle::Pointer.new(addr, size = 0, free = nil) -> Fiddle::Pointer (4.0)

• 2.5.0

• 特異メソッド

与えられた addr が指すメモリ領域を表す Pointer オブジェクトを生成して返します。

与えられた addr が指すメモリ領域を表す Pointer オブジェクトを生成して返します。

size を指定した場合、アドレス addr に確保されているメモリ領域のサイズは
size であると仮定されます。GC は free 関数を使用してメモリを解放します。

@param addr 生成する Pointer オブジェクトが指すアドレスを整数で指定します。

@param size 生成する Pointer オブジェクトが指すメモリ領域のサイズを整数で指定します。

@param free GC 時に呼ばれる free 関数を Fiddle::Function オブジェクトか
...

• Fiddle::Function
• Fiddle::Pointer

Fiddle::Pointer.to_ptr(val) -> Fiddle::Pointer (4.0)

• 2.5.0

• 特異メソッド

与えられた val と関連した Pointer オブジェクトを生成して返します。

与えられた val と関連した Pointer オブジェクトを生成して返します。

val が文字列の場合は文字列が格納されているメモリ領域を指す Pointer
オブジェクトを返します。

IO オブジェクトの場合は FILE ポインタを表す Pointer オブジェクトを返します。

val に to_ptr メソッドが定義されている場合は、val.to_ptr を呼び、
Pointer オブジェクトに変換したものを返します。

val が整数の場合はそれをアドレスとする Pointer オブジェクトを返します。

上以外の場合は、整数に変換(to_int)し
それをアドレスとする P...

• Fiddle::Pointer

File.absolute_path(file_name, dir_string=nil) -> String (4.0)

• 2.5.0

• 特異メソッド

file_name を絶対パスに変換した文字列を返します。

file_name を絶対パスに変換した文字列を返します。

相対パスの場合はカレントディレクトリを基準とします。
dir_string を渡した場合はそのディレクトリを基準とします。

File.expand_path と異なり、 file_name 先頭が "~" である場合
それは展開されません。普通のディレクトリ名として処理されます。

//emlist[例][ruby]{
p Dir.getwd #=> "/home/matz/work/bar"
p ENV["HOME"] #=> "/home/mat...

• File

File.atime(filename) -> Time (4.0)

• 2.5.0

• 特異メソッド

最終アクセス時刻を返します。

最終アクセス時刻を返します。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

//emlist[例][ruby]{
File.atime(__FILE__) # => 2017-11-28 22:38:44 +0900
//}

• File

絞り込み条件を変える

File.basename(filename, suffix = "") -> String (4.0)

• 2.5.0

• 特異メソッド

filename の一番後ろのスラッシュに続く要素を返します。もし、 引数 suffix が与えられて、かつそれが filename の末尾に 一致するなら、それを取り除いたものを返します。

filename の一番後ろのスラッシュに続く要素を返します。もし、
引数 suffix が与えられて、かつそれが filename の末尾に
一致するなら、それを取り除いたものを返します。

//emlist[例][ruby]{
p File.basename("ruby/ruby.c") #=> "ruby.c"
p File.basename("ruby/ruby.c", ".c") #=> "ruby"
p File.basename("ruby/ruby.c", ".*") #=> "ruby"
p File.basename("ruby/ruby.e...

• File

File.birthtime(filename) -> Time (4.0)

• 2.5.0

• 特異メソッド

作成された時刻を返します。

作成された時刻を返します。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

@raise NotImplementedError Windows のような birthtime のない環境で発生します。

//emlist[例][ruby]{
File.birthtime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003
//}

• File

File.blockdev?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#blockdev? と同じです。

FileTest.#blockdev? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。


@see FileTest.#blockdev?

• File

File.chardev?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#chardev? と同じです。

FileTest.#chardev? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.chmod(mode, *filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ファイルのモードを mode に変更します。モードを変更したファイ ルの数を返します。

ファイルのモードを mode に変更します。モードを変更したファイ
ルの数を返します。

@param filename ファイル名を表す文字列を指定します。

@param mode chmod(2) と同様に整数で指定します。

@raise Errno::EXXX モードの変更に失敗した場合に発生します。

• File

絞り込み条件を変える

File.chown(owner, group, *filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ファイルのオーナーとグループを変更します。スーパーユーザだけがファ イルのオーナーとグループを変更できます。変更を行ったファイルの数を 返します。

ファイルのオーナーとグループを変更します。スーパーユーザだけがファ
イルのオーナーとグループを変更できます。変更を行ったファイルの数を
返します。

@param filename ファイル名を表す文字列を指定します。

@param owner chown(2) と同様に数値で指定します。nil または -1 を指定することで、オーナーを現在のままにすることができます。

@param group chown(2) と同様に数値で指定します。nil または -1 を指定することで、グループを現在のままにすることができます。

@raise Errno::EXXX 変更に失敗した場合に発生し...

• File

File.ctime(filename) -> Time (4.0)

• 2.5.0

• 特異メソッド

状態が最後に変更された時刻を返します。 状態の変更とは chmod などによるものです。

状態が最後に変更された時刻を返します。
状態の変更とは chmod などによるものです。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

//emlist[例:][ruby]{
IO.write("testfile", "test")
File.ctime("testfile") # => 2017-11-30 22:40:49 +0900
File.chmod(0755, "testfile")
File.ctime("testfile") # => 2...

• File

File.delete(*filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ファイルを削除します。削除したファイルの数を返します。 削除に失敗した場合は例外 Errno::EXXX が発生します。

ファイルを削除します。削除したファイルの数を返します。
削除に失敗した場合は例外 Errno::EXXX が発生します。

このメソッドは通常ファイルの削除用で、ディレクトリの削除には
Dir.rmdir を使います。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("test.txt", "test")
p File.exist?("test.txt") # => true
p File.delete("test.txt") # => ...

• Errno::EXXX
• File

File.directory?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#directory? と同じです。

FileTest.#directory? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.dirname(filename) -> String (4.0)

• 2.5.0

• 特異メソッド

filename の一番後ろのスラッシュより前を文 字列として返します。スラッシュを含まないファイル名に対しては "."(カレントディレクトリ)を返します。

filename の一番後ろのスラッシュより前を文
字列として返します。スラッシュを含まないファイル名に対しては
"."(カレントディレクトリ)を返します。

//emlist[例][ruby]{
p File.dirname("dir/file.ext") # => "dir"
p File.dirname("file.ext") # => "."
//}

File.dirname の動作は dirname(3)
に従います。
//emlist[例][ruby]{
p File.dirname("foo/bar/") # => "foo"
p File.di...

• File

絞り込み条件を変える

File.empty?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#zero? と同じです。

FileTest.#zero? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.executable?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#executable? と同じです。

FileTest.#executable? と同じです。

@param path パスを表す文字列を指定します。

• File

File.executable_real?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#executable_real? と同じです。

FileTest.#executable_real? と同じです。

@param path パスを表す文字列を指定します。

• File

File.exist?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#exist? と同じです。

FileTest.#exist? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.exists?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

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

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

• File

絞り込み条件を変える

File.expand_path(path, default_dir = '.') -> String (4.0)

• 2.5.0

• 特異メソッド

path を絶対パスに展開した文字列を返します。 path が相対パスであれば default_dir を基準にします。

path を絶対パスに展開した文字列を返します。
path が相対パスであれば default_dir を基準にします。

先頭の ~ はホームディレクトリ(環境変数 HOME が使われます)に、
~USER はそのユーザのホームディレクトリに展開されます。

//emlist[例][ruby]{
p Dir.getwd #=> "/home/matz/work/foo"
p ENV["HOME"] #=> "/home/matz"
p File.expand_path("..") #=> "/h...

• File

File.extname(filename) -> String (4.0)

• 2.5.0

• 特異メソッド

ファイル名 filename の拡張子部分(最後の "." に続く文字列)を 返します。ディレクトリ名に含まれる "." や、ファイル名先頭の "." は拡張子の一部としては見なされません。filename に拡張子が含 まれない場合は空文字列を返します。

ファイル名 filename の拡張子部分(最後の "." に続く文字列)を
返します。ディレクトリ名に含まれる "." や、ファイル名先頭の "."
は拡張子の一部としては見なされません。filename に拡張子が含
まれない場合は空文字列を返します。

//emlist[例][ruby]{
p File.extname("foo/foo.txt") # => ".txt"
p File.extname("foo/foo.tar.gz") # => ".gz"
p File.extname("foo/bar") # => ""
p File.extname("f...

• File

File.file?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#file? と同じです。

FileTest.#file? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.fnmatch(pattern, path, flags = 0) -> bool (4.0)

• 2.5.0

• 特異メソッド

ファイル名のパターンマッチ fnmatch(3) を行います。 path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

ファイル名のパターンマッチ fnmatch(3) を行います。
path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

@param pattern パターンを文字列で指定します。ワイルドカードとして `*',
`?', `[]', `{}' が使用できます。
Dir.glob とは違って `**/' は使用できません。
//emlist[例][ruby]{
%w(foo foobar bar).each {|f|
p File.fnmatch("foo*", f)
}
# =>...

• File
• File::Constants

File.fnmatch?(pattern, path, flags = 0) -> bool (4.0)

• 2.5.0

• 特異メソッド

ファイル名のパターンマッチ fnmatch(3) を行います。 path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

ファイル名のパターンマッチ fnmatch(3) を行います。
path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

@param pattern パターンを文字列で指定します。ワイルドカードとして `*',
`?', `[]', `{}' が使用できます。
Dir.glob とは違って `**/' は使用できません。
//emlist[例][ruby]{
%w(foo foobar bar).each {|f|
p File.fnmatch("foo*", f)
}
# =>...

• File
• File::Constants

絞り込み条件を変える

File.ftype(filename) -> String (4.0)

• 2.5.0

• 特異メソッド

ファイルのタイプを表す文字列を返します。

ファイルのタイプを表す文字列を返します。

文字列は以下のうちのいずれかです。File.lstat(filename).ftype と同じです。
シンボリックリンクに対して "link" を返します。

* "file"
* "directory"
* "characterSpecial"
* "blockSpecial"
* "fifo"
* "link"
* "socket"
* "unknown"

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 情報の取得に失敗した場合に発生します。

//emlist[...

• File

File.grpowned?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#grpowned? と同じです。

FileTest.#grpowned? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.identical?(filename1, filename2) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#identical? と同じです。

FileTest.#identical? と同じです。

@param filename1 パスを表す文字列か IO オブジェクトを指定します。

@param filename2 パスを表す文字列か IO オブジェクトを指定します。

• File

File.join(*item) -> String (4.0)

• 2.5.0

• 特異メソッド

File::SEPARATORを間に入れて文字列を連結します。platform/DOSISH-supportで環境依存になる予定です。

File::SEPARATORを間に入れて文字列を連結します。platform/DOSISH-supportで環境依存になる予定です。

@param item 連結したいディレクトリ名やファイル名を文字列（もしくは文字列を要素に持つ配列）で与えます。
文字列AとBを連結する際に、Aの末尾の文字とBの先頭の文字がFile::SEPARATORであった場合には、
まずこれらを削除した上で改めてFile::SEPARATORを間に入れて連結します。
引数の中に配列がある場合は配列要素を再帰的に展開します。空の配列は空文字列に...

• File
• platform/DOSISH-support

File.lchmod(mode, *filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

File.chmod と同様ですが、シンボリックリンクに関してリンクそのものの モードを変更します。

File.chmod と同様ですが、シンボリックリンクに関してリンクそのものの
モードを変更します。

@param filename ファイル名を表す文字列を指定します。

@param mode chmod(2) と同様に整数で指定します。

@raise NotImplementedError lchmod(2) を実装していないシステムでこのメソッドを呼び出すと発生します。

@raise Errno::EXXX モードの変更に失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "test")
File.symlink("te...

• File

絞り込み条件を変える

File.lchown(owner, group, *filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

File#chown と同様ですが、 シンボリックリンクに関してリンクそのもののオーナー、 グループを変更します。

File#chown と同様ですが、
シンボリックリンクに関してリンクそのもののオーナー、
グループを変更します。

@param filename ファイル名を表す文字列を指定します。

@param owner chown(2) と同様に数値で指定します。nil または -1 を指定することで、オーナーを現在のままにすることができます。

@param group chown(2) と同様に数値で指定します。nil または -1 を指定することで、グループを現在のままにすることができます。

@raise NotImplementedError lchown(2) を実装していないシステ...

• File

File.link(old, new) -> 0 (4.0)

• 2.5.0

• 特異メソッド

old を指す new という名前のハードリンクを 生成します。old はすでに存在している必要があります。 ハードリンクに成功した場合は 0 を返します。

old を指す new という名前のハードリンクを
生成します。old はすでに存在している必要があります。
ハードリンクに成功した場合は 0 を返します。

失敗した場合は例外 Errno::EXXX が発生します。

@param old ファイル名を表す文字列を指定します。

@param new ファイル名を表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "test")
File.link("testfile", "testlink") # => 0...

• Errno::EXXX
• File

File.lstat(filename) -> File::Stat (4.0)

• 2.5.0

• 特異メソッド

File.statと同様ですが、シンボリックリンクに関してリンクそのものの 情報を File::Stat として返します。lstat(2) を実装していないシステムでは、File.stat と同じです。

File.statと同様ですが、シンボリックリンクに関してリンクそのものの
情報を File::Stat として返します。lstat(2) を実装していないシステムでは、File.stat と同じです。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 情報の取得に失敗した場合に発生します。

//emlist[例][ruby]{
# link.rb は t.rb のシンボリックリンク
File.lstat("link.rb") == File.stat("t.rb") # => false
File.stat("link.rb...

• File

File.lutime(atime, mtime, *filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ファイルの最終アクセス時刻と更新時刻を変更します。 シンボリックリンクに対しては File.utime　と違って、 シンボリックそのものを変更します。

ファイルの最終アクセス時刻と更新時刻を変更します。
シンボリックリンクに対しては File.utime　と違って、
シンボリックそのものを変更します。

@param atime 最終アクセス時刻を Time か、起算時からの経過秒数を数値で指定します。

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

@param filename ファイル名を表す文字列を指定します。複数指定できます。

@return 変更したファイルの数を返します。

@raise Errno::EXXX 変更に失敗した場合に発生します。

@see File.utim...

• File
• Time

File.mkfifo(file_name, mode = 0666) -> 0 (4.0)

• 2.5.0

• 特異メソッド

引数 file_name で指定した名前の FIFO スペシャルファイルを作成します。

引数 file_name で指定した名前の FIFO スペシャルファイルを作成します。

@param file_name ファイル名を指定します。

@param mode FIFO の許可モードを数値で指定します。指定したモードは通常の
ファイル作成と同様にプロセスの umask によって変更されます。
作成されたファイルの許可モードは (mode & ~umask) になります。

//emlist[例][ruby]{
File.mkfifo("testfile", 0666)
File.ftype("testfile") ...

• File

絞り込み条件を変える

File.mtime(filename) -> Time (4.0)

• 2.5.0

• 特異メソッド

最終更新時刻を返します。

最終更新時刻を返します。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

//emlist[例][ruby]{
File.mtime(__FILE__) # => 2017-12-03 03:16:22 +0900
//}

• File

File.new(path, mode = "r", perm = 0666) -> File (4.0)

• 2.5.0

• 特異メソッド

path で指定されるファイルをオープンし、File オブジェクトを生成して 返します。

path で指定されるファイルをオープンし、File オブジェクトを生成して
返します。

path が整数の場合はファイルディスクリプタとして扱い、それに対応する
File オブジェクトを生成して返します。IO.open と同じです。
ブロックを指定して呼び出した場合は、File オブジェクトを引数として
ブロックを実行します。ブロックの実行が終了すると、ファイルは自動的に
クローズされます。ブロックの実行結果を返します。

@param path ファイルを文字列で指定します。整数を指定した場合はファイルディスクリプタとして扱います。

@param mode モードを文字列か定数の論理...

• File

File.open(path, mode = "r", perm = 0666) -> File (4.0)

• 2.5.0

• 特異メソッド

path で指定されるファイルをオープンし、File オブジェクトを生成して 返します。

path で指定されるファイルをオープンし、File オブジェクトを生成して
返します。

path が整数の場合はファイルディスクリプタとして扱い、それに対応する
File オブジェクトを生成して返します。IO.open と同じです。
ブロックを指定して呼び出した場合は、File オブジェクトを引数として
ブロックを実行します。ブロックの実行が終了すると、ファイルは自動的に
クローズされます。ブロックの実行結果を返します。

@param path ファイルを文字列で指定します。整数を指定した場合はファイルディスクリプタとして扱います。

@param mode モードを文字列か定数の論理...

• File

File.open(path, mode = "r", perm = 0666) {|file| ... } -> object (4.0)

• 2.5.0

• 特異メソッド

path で指定されるファイルをオープンし、File オブジェクトを生成して 返します。

path で指定されるファイルをオープンし、File オブジェクトを生成して
返します。

path が整数の場合はファイルディスクリプタとして扱い、それに対応する
File オブジェクトを生成して返します。IO.open と同じです。
ブロックを指定して呼び出した場合は、File オブジェクトを引数として
ブロックを実行します。ブロックの実行が終了すると、ファイルは自動的に
クローズされます。ブロックの実行結果を返します。

@param path ファイルを文字列で指定します。整数を指定した場合はファイルディスクリプタとして扱います。

@param mode モードを文字列か定数の論理...

• File

File.owned?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#owned? と同じです。

FileTest.#owned? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

絞り込み条件を変える

File.path(filename) -> String (4.0)

• 2.5.0

• 特異メソッド

指定されたファイル名を文字列で返します。filename が文字列でない場合は、to_path メソッドを呼びます。

指定されたファイル名を文字列で返します。filename が文字列でない場合は、to_path メソッドを呼びます。

@param filename ファイル名を表す文字列か to_path メソッドが定義されたオブジェクトを指定します。

//emlist[例][ruby]{
require 'pathname'

class MyPath
def initialize(path)
@path = path
end
def to_path
File.absolute_path(@path)
end
end

File.path("/dev/null") ...

• File

File.pipe?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#pipe? と同じです。

FileTest.#pipe? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.readable?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#readable? と同じです。

FileTest.#readable? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.readable_real?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#readable_real? と同じです。

FileTest.#readable_real? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.readlink(path) -> String (4.0)

• 2.5.0

• 特異メソッド

シンボリックリンクのリンク先のパスを文字列で返します。

シンボリックリンクのリンク先のパスを文字列で返します。

@param path シンボリックリンクを表す文字列を指定します。

@raise Errno::EXXX 指定された path がシンボリックリンクでない場合や、リンクの読み取りに失敗した場合に発生します。

//emlist[例:][ruby]{
IO.write("testfile", "test")
File.symlink("testfile", "testlink") # => 0
File.readlink("testlink") # => "testfile"
//}

• File

絞り込み条件を変える

File.realdirpath(pathname, basedir = nil) -> String (4.0)

• 2.5.0

• 特異メソッド

与えられた pathname に対応する絶対パスを返します。

与えられた pathname に対応する絶対パスを返します。

pathname の最後のコンポーネントは存在していなくても例外は発生しません。

@param pathname ファイル名を指定します。

@param basedir ベースディレクトリを指定します。省略するとカレントディレクトリを使用します。

@raise Errno::ENOENT ファイルが存在しない場合に発生します。

• File

File.realpath(pathname, basedir = nil) -> String (4.0)

• 2.5.0

• 特異メソッド

与えられた pathname に対応する絶対パスを返します。

与えられた pathname に対応する絶対パスを返します。

pathname の全てのコンポーネントは存在しなければなりません。

@param pathname ファイル名を指定します。

@param basedir ベースディレクトリを指定します。省略するとカレントディレクトリを使用します。

@raise Errno::ENOENT ファイルが存在しない場合に発生します。

//emlist[例][ruby]{
ENV["HOME"] # => "/home/matz"
File.symlink("testfile", "testlink"...

• File

File.rename(from, to) -> 0 (4.0)

• 2.5.0

• 特異メソッド

ファイルの名前を変更します。ディレクトリが異なる場合には移動も行い ます。rename(2) を参照してください。移動先のファ イルが存在する時には上書きされます。

ファイルの名前を変更します。ディレクトリが異なる場合には移動も行い
ます。rename(2) を参照してください。移動先のファ
イルが存在する時には上書きされます。

ファイルの移動に成功した場合 0 を返します。失敗した場合は例外
Errno::EXXX が発生します。

@param from ファイルの名前を文字列で与えます。

@param to 新しいファイル名を文字列で与えます。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
begin
File.rename("testfile", "testfile.bak")...

• Errno::EXXX
• File

File.setgid?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#setgid? と同じです。

FileTest.#setgid? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.setuid?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#setuid? と同じです。

FileTest.#setuid? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

絞り込み条件を変える

File.size(path) -> Integer (4.0)

• 2.5.0

• 特異メソッド

FileTest.#size と同じです。

FileTest.#size と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.size?(path) -> Integer | nil (4.0)

• 2.5.0

• 特異メソッド

FileTest.#size? と同じです。

FileTest.#size? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.socket?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#socket? と同じです。

FileTest.#socket? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.split(pathname) -> [String] (4.0)

• 2.5.0

• 特異メソッド

pathname を dirname とbasename に分割して、2 要 素の配列を返します。

pathname を dirname とbasename に分割して、2 要
素の配列を返します。

//emlist[][ruby]{
[File.dirname(pathname), File.basename(pathname)]
//}

と同じです。

@param pathname パス名を表す文字列を指定します。

• File

File.stat(filename) -> File::Stat (4.0)

• 2.5.0

• 特異メソッド

filename の情報を含む File::Stat オブジェクトを生成し て返します。

filename の情報を含む File::Stat オブジェクトを生成し
て返します。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 情報の取得に失敗した場合に発生します。

//emlist[例][ruby]{
File.stat("testfile").class # => File::Stat
File.stat("testfile").mtime # => 2017-12-10 01:13:56 +0900
//}

@see IO#stat, File#lstat

• File
• File::Stat

絞り込み条件を変える

File.sticky?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#sticky? と同じです。

FileTest.#sticky? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.symlink(old, new) -> 0 (4.0)

• 2.5.0

• 特異メソッド

old への new という名前のシンボリックリンクを生成します。

old への new という名前のシンボリックリンクを生成します。

シンボリックリンクの作成に成功すれば 0 を返します。失敗した場合は
例外 Errno::EXXX が発生します。

@param old ファイル名を表す文字列を指定します。

@param new シンボリックリンクを表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
File.symlink("testfile", "testlink") # => 0
//}

• Errno::EXXX
• File

File.symlink?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#symlink? と同じです。

FileTest.#symlink? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File.truncate(path, length) -> 0 (4.0)

• 2.5.0

• 特異メソッド

path で指定されたファイルのサイズを最大 length バイト にします。

path で指定されたファイルのサイズを最大 length バイト
にします。

サイズの変更に成功すれば 0 を返します。失敗した場合は例外
Errno::EXXX が発生します。

@param path パスを表す文字列を指定します。

@param length 変更したいサイズを整数で与えます。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "1234567890")
File.truncate("testfile", 5) # => 0
File.size("testfil...

• Errno::EXXX
• File

File.umask -> Integer (4.0)

• 2.5.0

• 特異メソッド

現在の umask の値を返します。

現在の umask の値を返します。

@see umask(2)

• File

絞り込み条件を変える

File.umask(umask) -> Integer (4.0)

• 2.5.0

• 特異メソッド

umask を変更します。変更前の umask の値を返します。

umask を変更します。変更前の umask の値を返します。

@param umask 設定したい umask の値を整数で指定します。

//emlist[例][ruby]{
File.umask(0006) # => 18
File.umask # => 6
//}

@see umask(2)

• File

File.unlink(*filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ファイルを削除します。削除したファイルの数を返します。 削除に失敗した場合は例外 Errno::EXXX が発生します。

ファイルを削除します。削除したファイルの数を返します。
削除に失敗した場合は例外 Errno::EXXX が発生します。

このメソッドは通常ファイルの削除用で、ディレクトリの削除には
Dir.rmdir を使います。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("test.txt", "test")
p File.exist?("test.txt") # => true
p File.delete("test.txt") # => ...

• Errno::EXXX
• File

File.utime(atime, mtime, *filename) -> Integer (4.0)

• 2.5.0

• 特異メソッド

ファイルの最終アクセス時刻と更新時刻を変更します。 シンボリックリンクに対しては File.lutime　と違って、 シンボリックのリンク先を変更します。

ファイルの最終アクセス時刻と更新時刻を変更します。
シンボリックリンクに対しては File.lutime　と違って、
シンボリックのリンク先を変更します。

@param atime 最終アクセス時刻を Time か、起算時からの経過秒数を数値で指定します。

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

@param filename ファイル名を表す文字列を指定します。複数指定できます。

@return 変更したファイルの数を返します。

@raise Errno::EXXX 変更に失敗した場合に発生します。

//emlist[例: ...

• File
• Time

File.world_readable?(path) -> Integer | nil (4.0)

• 2.5.0

• 特異メソッド

path が全てのユーザから読めるならばそのファイルのパーミッションを表す 整数を返します。そうでない場合は nil を返します。

path が全てのユーザから読めるならばそのファイルのパーミッションを表す
整数を返します。そうでない場合は nil を返します。

整数の意味はプラットフォームに依存します。

@param path パスを表す文字列か IO オブジェクトを指定します。

//emlist[例][ruby]{
m = File.world_readable?("/etc/passwd")
"%o" % m # => "644"
//}

• File

File.world_writable?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

path が全てのユーザから書き込めるならば、そのファイルのパーミッションを表す 整数を返します。そうでない場合は nil を返します。

path が全てのユーザから書き込めるならば、そのファイルのパーミッションを表す
整数を返します。そうでない場合は nil を返します。

整数の意味はプラットフォームに依存します。

@param path パスを表す文字列か IO オブジェクトを指定します。

//emlist[例][ruby]{
m = File.world_writable?("/tmp")
"%o" % m #=> "777"
//}

• File

絞り込み条件を変える

File.writable?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#writable? と同じです。

FileTest.#writable? と同じです。

@param path パスを表す文字列を指定します。

• File

File.writable_real?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#writable_real? と同じです。

FileTest.#writable_real? と同じです。

@param path パスを表す文字列を指定します。

• File

File.zero?(path) -> bool (4.0)

• 2.5.0

• 特異メソッド

FileTest.#zero? と同じです。

FileTest.#zero? と同じです。

@param path パスを表す文字列か IO オブジェクトを指定します。

• File

File::Stat.new(path) -> File::Stat (4.0)

• 2.5.0

• 特異メソッド

path に関する File::Stat オブジェクトを生成して返します。 File.stat と同じです。

path に関する File::Stat オブジェクトを生成して返します。
File.stat と同じです。

@param path ファイルのパスを指定します。

@raise Errno::ENOENT pathに該当するファイルが存在しない場合発生します。

//emlist[][ruby]{
p $:[0]
#=> 例
# "C:/Program Files/ruby-1.8/lib/ruby/site_ruby/1.8"
p File::Stat.new($:[0])
#=> 例
#<File::Stat dev=0x2, ino=0, mode=040755, nlink=1,...

• File::Stat

FileUtils.collect_method(opt) -> Array (4.0)

• 2.5.0

• 特異メソッド

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

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

@param opt オプション名をシンボルで指定します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.collect_method(:preserve) # => ["cp", "cp_r", "copy", "install"]
//}

• FileUtils

絞り込み条件を変える

FileUtils.commands -> Array (4.0)

• 2.5.0

• 特異メソッド

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

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

//emlist[][ruby]{
require 'fileutils'
FileUtils.commands # => ["chmod", "cp", "cp_r", "install", ...]
//}

• FileUtils

FileUtils.have_option?(mid, opt) -> bool (4.0)

• 2.5.0

• 特異メソッド

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

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

@param mid メソッド名を指定します。

@param opt オプション名を指定します。

• FileUtils

FileUtils.options -> Array (4.0)

• 2.5.0

• 特異メソッド

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

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

//emlist[][ruby]{
require 'fileutils'
FileUtils.options
# => ["noop", "verbose", "force", "mode", "parents", "owner", "group", "preserve", "dereference_root", "remove_destination", "secure", "mtime", "nocreate"]
//}

• FileUtils

FileUtils.options_of(mid) -> Array (4.0)

• 2.5.0

• 特異メソッド

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

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

@param mid メソッド名を指定します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.options_of(:rm) # => ["noop", "verbose", "force"]
//}

• FileUtils

Forwardable.debug -> bool (4.0)

• 2.5.0

• 特異メソッド

委譲部分をバックトレースに含めるかどうかの状態を返します。

委譲部分をバックトレースに含めるかどうかの状態を返します。

バックトレースを含める設定となっている時、真を返します。
デフォルトは含めない設定となっています。

• Forwardable

絞り込み条件を変える

Forwardable.debug= -> bool (4.0)

• 2.5.0

• 特異メソッド

委譲部分をバックトレースに含めるかどうかの状態を設定します。

委譲部分をバックトレースに含めるかどうかの状態を設定します。

• Forwardable

FrozenError.new(error_message = "") -> FrozenError (4.0)

• 2.5.0

• 特異メソッド

例外オブジェクトを生成して返します。

例外オブジェクトを生成して返します。

@param error_message エラーメッセージを表す文字列です


//emlist[][ruby]{
err = FrozenError.new("message")
p err # => #<FrozenError: message>
//}

• FrozenError

GC.count -> Integer (4.0)

• 2.5.0

• 特異メソッド

プロセス開始からガーベージコレクトを実行した回数を Integer で返し ます。

プロセス開始からガーベージコレクトを実行した回数を Integer で返し
ます。

//emlist[例][ruby]{
GC.count # => 3
//}

• GC
• Integer

GC.disable -> bool (4.0)

• 2.5.0

• 特異メソッド

ガーベージコレクトを禁止します。

ガーベージコレクトを禁止します。

前回の禁止状態を返します(禁止されていたなら true, GC が有効であったなら、
false)。

//emlist[例][ruby]{
GC.disable # => false
GC.disable # => true
//}

@see GC.enable

• GC

GC.enable -> bool (4.0)

• 2.5.0

• 特異メソッド

ガーベージコレクトを許可します。

ガーベージコレクトを許可します。

前回の禁止状態を返します(禁止されていたなら true, GC が有効であったなら、
false)。

@see GC.disable

//emlist[例][ruby]{
GC.disable # => false
GC.enable # => true
GC.enable # => false
//}

• GC

絞り込み条件を変える

GC.latest_gc_info(key) -> object (4.0)

• 2.5.0

• 特異メソッド

最新のGCの情報を返します。

最新のGCの情報を返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。

@param key 得られる情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

//emlist[例][ruby]{
latest = GC.latest_gc_info
latest # => {:major_by=>nil, :gc_by=>:newobj, :ha...

• GC

GC.latest_gc_info(result_hash = {}) -> Hash (4.0)

• 2.5.0

• 特異メソッド

最新のGCの情報を返します。

最新のGCの情報を返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。

@param key 得られる情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

//emlist[例][ruby]{
latest = GC.latest_gc_info
latest # => {:major_by=>nil, :gc_by=>:newobj, :ha...

• GC

GC.start(full_mark: true, immediate_sweep: true) -> nil (4.0)

• 2.5.0

• 特異メソッド

ガーベージコレクトを開始します。

ガーベージコレクトを開始します。

GC#garbage_collect や ObjectSpace.#garbage_collect と同じ働きをします。
GC.disable により GC が禁止されている場合でもガベージコレクトを開始します。

nil を返します。

@param full_mark マイナー GC を動作させる場合は false を、そうでない場
合は true を指定します。

@param immediate_sweep sweep を遅らせる(Lazy Sweep を行う)場合は false
...

• GC

GC.stat(key) -> Numeric (4.0)

• 2.5.0

• 特異メソッド

GC 内部の統計情報を Hash で返します。

GC 内部の統計情報を Hash で返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。


@param key 得られる統計情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

@return GC 内部の統計情報をHash で返します。
引数 key を指定した場合は数値を返します。

GC.stat
# =>
...

• GC
• Hash

GC.stat(result_hash = {}) -> {Symbol => Integer} (4.0)

• 2.5.0

• 特異メソッド

GC 内部の統計情報を Hash で返します。

GC 内部の統計情報を Hash で返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。


@param key 得られる統計情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

@return GC 内部の統計情報をHash で返します。
引数 key を指定した場合は数値を返します。

GC.stat
# =>
...

• GC
• Hash

絞り込み条件を変える

GC.stress -> bool (4.0)

• 2.5.0

• 特異メソッド

GCがストレスモードかどうかを返します。

GCがストレスモードかどうかを返します。

真が設定されている場合は GC を行えるすべての機会に GC を行います。

@see GC.stress=

• GC

GC.stress=(value) (4.0)

• 2.5.0

• 特異メソッド

GCのストレスモードを引数 value に設定します。 引数 value が真に設定されている間は、GC を行えるすべての機会に GC を行います。

GCのストレスモードを引数 value に設定します。
引数 value が真に設定されている間は、GC を行えるすべての機会に GC を行います。

この機能はデバッグ用途に提供されています。ストレスモードを有効にすると
プログラムのパフォーマンスが低下します。

@param value 任意のオブジェクト。整数以外の値を指定した場合は真偽値として解釈されます。
整数を指定する場合は以下のフラグをOR演算した値を指定します。
: 0x01
マイナー GC を動作させる場合に指定します。
: 0x02
sweep を遅らせる(Lazy Sweep を行う)...

• GC

GC::Profiler.clear -> nil (4.0)

• 2.5.0

• 特異メソッド

蓄積している GC のプロファイル情報をすべて削除します。

蓄積している GC のプロファイル情報をすべて削除します。

例:
GC::Profiler.enable
GC.start
GC.start
GC::Profiler.report #=> 2 回分の GC のプロファイル情報出力する。
GC::Profiler.clear
GC.start
GC::Profiler.report #=> 1 回分の GC のプロファイル情報出力する。

• GC::Profiler

GC::Profiler.disable -> nil (4.0)

• 2.5.0

• 特異メソッド

GC のプロファイラを停止します。

GC のプロファイラを停止します。

例:
GC::Profiler.disable
GC::Profiler.enabled? #=> false

このメソッドでは、蓄積したプロファイル情報は破棄しません。
破棄したい場合は GC::Profiler.clear を呼び出してください。

@see GC::Profiler.enable, GC::Profiler.enabled?

• GC::Profiler

GC::Profiler.enable -> nil (4.0)

• 2.5.0

• 特異メソッド

GC のプロファイラを起動します。

GC のプロファイラを起動します。

このメソッドを呼び出してから GC が発生すると、
GC についてプロファイル情報を取得します。

例:
GC::Profiler.enable
GC::Profiler.enabled? #=> true

@see GC::Profiler.disable, GC::Profiler.enabled?

• GC::Profiler

絞り込み条件を変える