Класс QFileDevice

Класс QFileDevice предоставляет интерфейс для чтения из и записи в открытые файлы. Подробнее...

Этот класс был представлен в Qt 5.0.

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются перевходными.

Открытые типы

Открытые функции

Переопределённые открытые функции

Переопределённые защищённые функции

Подробное описание

QFileDevice — базовый класс для устройств ввода/вывода, которые могут читать и записывать текстовые и двоичные файлы, а также ресурсы. QFile предоставляет основную функциональность, QFileDevice служит базовым классом для совместного использования функциональности с другими устройствами файлов, такими как QTemporaryFile, обеспечивая все операции, которые можно выполнить с файлами, открытыми с помощью QFile или QTemporaryFile.

См. также QFile и QTemporaryFile.

Документация по типам членов

Перечисление QFileDevice::FileError

Это перечисление описывает ошибки, которые могут быть возвращены функцией error().

Перечисление QFileDevice::FileHandleFlagФлаги QFileDevice::FileHandleFlags

Это перечисление используется при открытии файла для указания дополнительных опций, которые применяются только к файлам, а не к общему QIODevice.

Тип FileHandleFlags является типом-псевдонимом для QFlags<FileHandleFlag>. Он хранит логическое ИЛИ комбинацию значений FileHandleFlag.

enum QFileDevice::FileTime

Этот перечисление используется функциями fileTime() и setFileTime().

Это перечисление было введено или изменено в Qt 5.10.

См. также setFileTime(), fileTime(), и QFileInfo::fileTime().

enum QFileDevice::MemoryMapFlags

Это перечисление описывает специальные параметры, которые могут быть использованы функцией map().

Это перечисление было введено или изменено в Qt 4.4.

enum QFileDevice::Permissionflags QFileDevice::Permissions

Это перечисление используется функцией permission() для получения разрешений и владения файлом. Значения могут быть объединены с помощью логического ИЛИ для проверки нескольких разрешений и значений владения.

Предупреждение: Из-за различий в платформах, поддерживаемых Qt, семантика ReadUser, WriteUser и ExeUser зависит от платформы: в Unix возвращаются права владельца файла, а в Windows — права текущего пользователя. Это поведение может измениться в будущих версиях Qt.

Примечание: В файловых системах NTFS проверка владения и прав по умолчанию отключена для повышения производительности. Чтобы включить её, добавьте следующую строку:

extern Q_CORE_EXPORT int qt_ntfs_permission_lookup;

Проверка разрешений включается и выключается, увеличивая и уменьшая qt_ntfs_permission_lookup на 1.

qt_ntfs_permission_lookup++; // turn checking on
qt_ntfs_permission_lookup--; // turn it off again

Тип Permissions является типом-псевдонимом для QFlags<Permission>. Он хранит логическое ИЛИ комбинацию значений Permission.

Документация по функциям-членам

[virtual] QFileDevice::~QFileDevice()

Уничтожает устройство файла, закрывая его при необходимости.

[override virtual] bool QFileDevice::atEnd() const

Переопределяет: QIODevice::atEnd() const.

Возвращает true, если достигнут конец файла; в противном случае возвращает false.

Для обычных пустых файлов в Unix (например, тех, что в /proc), эта функция возвращает true, так как файловая система сообщает, что размер такого файла равен 0. Поэтому вы не должны полагаться на atEnd() при чтении данных из такого файла, а вместо этого вызывайте read() до тех пор, пока больше данных нет.

[override virtual] void QFileDevice::close()

Переопределяет: QIODevice::close().

Вызывает QFileDevice::flush() и закрывает файл. Ошибки из flush игнорируются.

См. также QIODevice::close().

QFileDevice::FileError QFileDevice::error() const

Возвращает состояние ошибки файла.

Устройство ввода-вывода возвращает код ошибки. Например, если open() возвращает false, или операция чтения/записи возвращает -1, можно вызвать эту функцию, чтобы узнать причину, по которой операция завершилась неудачно.

См. также unsetError().

[virtual] QString QFileDevice::fileName() const

Возвращает имя файла. По умолчанию в QFileDevice возвращает пустую строку.

QDateTime QFileDevice::fileTime(QFileDevice::FileTime time) const

Возвращает время файла, указанное параметром time. Если время определить невозможно, возвращает QDateTime() (некорректное время).

Эта функция была введена в Qt 5.10.

См. также setFileTime(), FileTime, и QDateTime::isValid().

bool QFileDevice::flush()

Сбрасывает любые буферизованные данные в файл. Возвращает true при успехе; в противном случае возвращает false.

int QFileDevice::handle() const

Возвращает дескриптор файла.

Это небольшое положительное целое число, пригодное для использования с функциями C-библиотеки, такими как fdopen() и fcntl(). В системах, использующих дескрипторы для сокетов (т.е. в системах Unix, но не в Windows), дескриптор также можно использовать с QSocketNotifier.

Если файл не открыт или есть ошибка, handle() возвращает -1.

См. также QSocketNotifier.

[override virtual] bool QFileDevice::isSequential() const

Переопределяет: QIODevice::isSequential() const.

Возвращает true если файл можно обрабатывать только последовательно; в противном случае возвращает false.

Большинство файлов поддерживают произвольный доступ, но некоторые специальные файлы могут не поддерживать его.

См. также QIODevice::isSequential().

uchar *QFileDevice::map(qint64 offset, qint64 size, QFileDevice::MemoryMapFlags flags = NoOptions)

Карта размером size байт файла в памяти, начиная с offset. Файл должен быть открыт для успешного отображения, но файл не обязательно должен оставаться открытым после отображения памяти. При уничтожении QFile или открытии нового файла с этим объектом все карты, которые не были отображены, будут автоматически отображены.

Отображение будет иметь тот же режим открытия, что и файл (чтение и/или запись), за исключением использования MapPrivateOption, в этом случае запись в отображенную память всегда возможна.

Любые параметры отображения могут быть переданы через flags.

Возвращает указатель на память или nullptr в случае ошибки.

См. также unmap().

[virtual] QFileDevice::Permissions QFileDevice::permissions() const

Возвращает полное логическое ИЛИ сочетание QFile::Permission для файла.

См. также setPermissions().

[override virtual] qint64 QFileDevice::pos() const

Реализует: QIODevice::pos() const.

[override virtual protected] qint64 QFileDevice::readData(char *data, qint64 len)

Реализует: QIODevice::readData(char *data, qint64 maxSize).

[override virtual protected] qint64 QFileDevice::readLineData(char *data, qint64 maxlen)

Реализует: QIODevice::readLineData(char *data, qint64 maxSize).

[virtual] bool QFileDevice::resize(qint64 sz)

Устанавливает размер файла (в байтах) sz. Возвращает true если изменение размера прошло успешно; в противном случае false. Если sz больше, чем текущий размер файла, новые байты будут установлены в 0; если sz меньше, файл просто усекается.

Предупреждение: Эта функция может завершиться неудачей, если файла не существует.

См. также size().

[override virtual] bool QFileDevice::seek(qint64 pos)

Реализует: QIODevice::seek(qint64 pos).

Для устройств с произвольным доступом эта функция устанавливает текущую позицию в pos, возвращая true при успехе или false в случае ошибки. Для последовательных устройств поведение по умолчанию — ничего не делать и возвращать false.

Переход за пределы конца файла: если позиция находится за пределами конца файла, то seek() немедленно не расширит файл. Если выполняется запись в этой позиции, файл будет расширен. Содержимое файла между предыдущим концом файла и новыми записанными данными НЕОПРЕДЕЛЁНО и зависит от платформы и файловой системы.

bool QFileDevice::setFileTime(const QDateTime &newDate, QFileDevice::FileTime fileTime)

Устанавливает время файла, указанное fileTime, в newDate, возвращая true в случае успеха; в противном случае возвращает false.

Примечание: Файл должен быть открыт для использования этой функции.

Эта функция была добавлена в Qt 5.10.

См. также fileTime() и FileTime.

[virtual] bool QFileDevice::setPermissions(QFileDevice::Permissions permissions)

Устанавливает разрешения файла на заданные permissions. Возвращает true при успехе или false если разрешения не могут быть изменены.

Предупреждение: Эта функция не манипулирует ACL, что может ограничить её эффективность.

См. также permissions().

[override virtual] qint64 QFileDevice::size() const

Реализует: QIODevice::size() const.

Возвращает размер файла.

Для обычных пустых файлов в Unix (например, тех, что в /proc), эта функция возвращает 0; содержимое такого файла генерируется по требованию при вызове read().

bool QFileDevice::unmap(uchar *address)

Отменяет отображение памяти address.

Возвращает true если отображение отменено успешно; false в противном случае.

См. также map().

void QFileDevice::unsetError()

Устанавливает ошибку файла в QFileDevice::NoError.

См. также error().

[override virtual protected] qint64 QFileDevice::writeData(const char *data, qint64 len)

Реализует: QIODevice::writeData(const char *data, qint64 maxSize).