модуль File::Constants

Модуль File::Constants определяет константы, связанные с файлами.

Здесь есть две группы констант:

Те, которые относятся к доступу к файлам.
Те, которые относятся к сопоставлению имён файлов по шаблону.

Файловые константы, определённые для локального процесса, могут быть получены с помощью метода File::Constants.constants:

File::Constants.constants.take(5)
# => [:RDONLY, :WRONLY, :RDWR, :APPEND, :CREAT]

Доступ к файлам

Константы доступа к файлам могут быть использованы с необязательным аргументом mode в вызовах следующих методов:

Доступ для чтения/записи

Доступ для чтения/записи для потока может быть указан с помощью константы доступа к файлу.

Константа может быть указана как часть побитового ИЛИ других таких констант.

Любое сочетание констант в этом разделе может быть указано.

File::RDONLY

Флаг File::RDONLY указывает, что поток должен быть открыт только для чтения:

filepath = '/tmp/t.tmp'
f = File.new(filepath, File::RDONLY)
f.write('Foo') # Raises IOError (not opened for writing).

File::WRONLY

Флаг File::WRONLY указывает, что поток должен быть открыт только для записи:

f = File.new(filepath, File::WRONLY)
f.read # Raises IOError (not opened for reading).

File::RDWR

Флаг File::RDWR указывает, что поток должен быть открыт для чтения и записи:

f = File.new(filepath, File::RDWR)
f.write('Foo') # => 3
f.rewind       # => 0
f.read         # => "Foo"

Позиционирование файла

File::APPEND

Флаг File::APPEND указывает, что поток должен быть открыт в режиме добавления.

Перед каждой операцией записи позиция устанавливается в конец потока. Изменение позиции и последующая операция записи выполняются как единый атомарный шаг.

File::TRUNC

Флаг File::TRUNC указывает, что поток должен быть обрезан в начале. Если файл существует и успешно открыт для записи, он будет обрезан до позиции ноль; его ctime и mtime обновляются.

На FIFO-специальном файле или терминальном устройстве никакого эффекта нет. Действие на другие типы файлов определяется реализацией. Результат использования File::TRUNC с File::RDONLY не определён.

Создание и сохранение

File::CREAT

Флаг File::CREAT указывает, что поток должен быть создан, если он ещё не существует.

Если файл существует:

- Raise an exception if File::EXCL is also specified.
- Otherwise, do nothing.

Если файл не существует, то он создаётся. После успешного завершения atime, ctime и mtime файла обновляются, а также ctime и mtime родительского каталога.

File::EXCL

Флаг File::EXCL указывает, что поток не должен уже существовать; Если флаги File::CREAT и File::EXCL оба указаны и поток уже существует, генерируется исключение.

Проверка существования и создания файла выполняется как атомарная операция.

Если оба File::EXCL и File::CREAT указаны, и путь является символической ссылкой, генерируется исключение независимо от содержимого символической ссылки.

Если File::EXCL указан, а File::CREAT не указан, результат не определён.

POSIX-константы файлов

Некоторые константы доступа к файлам определены только на POSIX-совместимых системах; это:

File::SYNC.
File::DSYNC.
File::RSYNC.
File::DIRECT.
File::NOATIME.
File::NOCTTY.
File::NOFOLLOW.
File::TMPFILE.

File::SYNC, File::RSYNC и File::DSYNC

Флаг File::SYNC, File::RSYNC или File::DSYNC указывает синхронизацию операций ввода-вывода с файловой системой.

Эти флаги допустимы только для POSIX-совместимых систем.

File::SYNC указывает, что все операции записи (данные и метаданные) немедленно должны быть выведены на устройство хранения. Это означает, что данные записываются на устройство хранения, а также метаданные файла (например, размер файла, отметки времени, разрешения) также синхронизируются. Это гарантирует, что данные безопасно сохранены на носителе перед возвратом управления вызывающей программе. Этот флаг может существенно повлиять на производительность, так как он требует синхронных записей, что может быть медленнее по сравнению с асинхронными записями.
File::RSYNC указывает, что любые операции чтения файла не вернут значение, пока все незавершенные операции записи (те, которые были выполнены, но не завершены) не будут также синхронизированы. Это полезно, когда вы хотите прочитать самые последние данные, которые могут всё ещё обрабатываться.
File::DSYNC указывает, что все операции записи данных немедленно должны быть выведены на устройство хранения; это отличается от File::SYNC, которое требует синхронизации метаданных.

Обратите внимание, что поведение этих флагов может немного отличаться в зависимости от используемой операционной системы и файловой системы. Кроме того, использование этих флагов может повлиять на производительность из-за синхронного характера операций ввода-вывода, поэтому их следует использовать разумно, особенно в приложениях, критичных к производительности.

File::NOCTTY

Флаг File::NOCTTY указывает, что если поток является терминальным устройством, это устройство не становится управляющим терминалом для процесса.