module File::Constants

要約

File に関る定数を集めたモジュール。

File はこのモジュールをインクルードしているので、以下に挙げる定数は File の定数のように扱うことができます。

Ruby 1.8 以降では、File ではなく、IO でインクルードされるようになりました。

目次

定数

• APPEND
• BINARY
• CREAT
• DIRECT
• DSYNC
• EXCL
• FNM_CASEFOLD
• FNM_DOTMATCH
• FNM_EXTGLOB
• FNM_NOESCAPE
• FNM_PATHNAME
• FNM_SYSCASE
• LOCK_EX
• LOCK_NB
• LOCK_SH
• LOCK_UN
• NOATIME
• NOCTTY
• NOFOLLOW
• NONBLOCK
• NULL
• RDONLY
• RDWR
• RSYNC
• SHARE_DELETE
• SYNC
• TMPFILE
• TRUNC
• WRONLY

定数

APPEND -> Integer[permalink][rdoc]

追記モードでファイルを開くときに指定します。 File.openで使用します。

BINARY -> Integer[permalink][rdoc]

ファイルをバイナリとして開きます。 open(2) で O_BINARYが指定できる場合に使えます。 File.openで使用します。

CREAT -> Integer[permalink][rdoc]

ファイルがなければ作成するよう指定します。 File.openで使用します。

DIRECT -> Integer[permalink][rdoc]

このファイルに対する I/O のキャッシュの効果を最小化しようとする。

このフラグを使うと、一般的に性能が低下する。 しかしアプリケーションが独自にキャッシングを行っているような 特別な場合には役に立つ。 ファイルの I/O はユーザー空間バッファに対して直接行われる。 File::Constants::DIRECT フラグ自身はデータを同期で転送しようとはするが、 File::Constants::SYNC のようにデータと必要なメタデータの転送が保証されるわけではない。 同期 I/O を保証するためには、 File::Constants::DIRECT に加えて File::Constants::SYNC を使用しなければならない。

File.openで使用します。

DSYNC -> Integer[permalink][rdoc]

ファイルをデータ同期モードで開きます。 open(2) で O_DSYNC が指定できる場合に使えます。 File.openで使用します。

EXCL -> Integer[permalink][rdoc]

CREATと併用し、もしファイルが既にある場合には失敗します。 File.openで使用します。

FNM_CASEFOLD -> Integer[permalink][rdoc]

アルファベットの大小文字を区別せずにパターンマッチを行います。 File.fnmatch, Dir.globで使用します。

FNM_DOTMATCH -> Integer[permalink][rdoc]

ワイルドカード `*', `?', `[]' が先頭の `.' にマッチするようになります。 File.fnmatch, Dir.globで使用します。

FNM_EXTGLOB -> Integer[permalink][rdoc]

{} 内のコンマで区切られた文字列の組合せにマッチするようになります。 File.fnmatch で使用します。

FNM_NOESCAPE -> Integer[permalink][rdoc]

エスケープ文字 `\' を普通の文字とみなします。 File.fnmatch, Dir.globで使用します。

FNM_PATHNAME -> Integer[permalink][rdoc]

ワイルドカード `*', `?', `[]' が `/' にマッチしなくなります。シェルのパターンマッチにはこのフラグが使用されています。 File.fnmatch, Dir.globで使用します。

FNM_SYSCASE -> Integer[permalink][rdoc]

case hold なファイルシステムの場合、FNM_CASEFOLD の値になり、そうでなければゼロの値になります。 File.fnmatch, Dir.globで使用します。

LOCK_EX -> Integer[permalink][rdoc]

排他ロック。同時にはただひとつのプロセスだけがロックを保持できます。 File#flock で使用します。

LOCK_NB -> Integer[permalink][rdoc]

ロックの際にブロックしない。他の指定と or することで指定します。 File#flock で使用します。

LOCK_SH -> Integer[permalink][rdoc]

共有ロック。複数のプロセスが同時にロックを共有できます。 File#flock で使用します。

LOCK_UN -> Integer[permalink][rdoc]

アンロック。File#flock で使用します。

NOATIME -> Integer[permalink][rdoc]

ファイル読み込み時に atime を更新しません。 open(2) で O_ATIME が指定できる場合に使えます。 File.openで使用します。

atime が更新されないのは確実ではないということに注意してください。これは性能のためのオプションです。

NOCTTY -> Integer[permalink][rdoc]

自身がTTY制御しないようにTTYを開きます。 File.openで使用します。

NOFOLLOW -> Integer[permalink][rdoc]

ファイルがシンボリックリンクであった場合に例外を発生させます。 open(2) で O_NOFOLLOW が指定できる場合に使えます。 File.openで使用します。

NONBLOCK -> Integer[permalink][rdoc]

ファイルが利用可能じゃなくてもブロックしません。 File.openで使用します。

NULL -> String[permalink][rdoc]

NULLデバイスのファイル名です。

RDONLY -> Integer[permalink][rdoc]

読み込みのみのモードでファイルを開くときに指定します。 File.openで使用します。

RDWR -> Integer[permalink][rdoc]

読み書き両方のモードでファイルを開くときに指定します。 File.openで使用します。

RSYNC -> Integer[permalink][rdoc]

ファイルを読み込み時同期モードで開きます。 open(2) で O_RSYNC が指定できる場合に使えます。 File.openで使用します。

SHARE_DELETE -> Integer[permalink][rdoc]

ファイルを開いたままの状態でも削除できるように指定して開きます。 O_SHARE_DELETE が指定できる場合に使えます。 File.openで使用します。

2.3.0 現在はファイルをバイナリとして開いた場合のみ有効です。

SYNC -> Integer[permalink][rdoc]

ファイルを同期モードで開きます。 open(2) で O_SYNCが指定できる場合に使えます。 File.openで使用します。

TMPFILE -> Integer[permalink][rdoc]

名前なしの一時ファイルを作成します。 open(2) で O_TMPFILE が指定できる場合に使えます。 File.openで使用します。

TRUNC -> Integer[permalink][rdoc]

もしファイルが存在するなら、中身を抹消してサイズをゼロにします。 File.openで使用します。

WRONLY -> Integer[permalink][rdoc]

書き込みのみのモードでファイルを開くときに指定します。 File.openで使用します。

フィードバックはこちら