Класс QFileDevice

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

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

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

Типы общедоступного доступа

Общедоступные функции

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

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

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

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

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

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

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

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

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

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

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

[since 5.10] перечисление QFileDevice::FileTime

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

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

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

перечисление QFileDevice::MemoryMapFlagфлаги QFileDevice::MemoryMapFlags

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

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

перечисление QFileDevice::Permissionфлаги 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 возвращается пустая строка.

[since 5.10] 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() немедленно не расширяет файл. Если выполняется запись в эту позицию, то файл расширяется. Содержимое файла между предыдущим концом файла и новыми данными НЕОПРЕДЕЛЁННО и зависит от платформы и файловой системы.

[since 5.10] 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).