module 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 указывает, что если поток является терминальным устройством, это устройство не становится управляющим терминалом процесса.