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