Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QFileSystemEngine Class Reference

#include <qfilesystemengine_p.h>

Collaboration diagram for QFileSystemEngine:

Public Types

using TriStateResult = QAbstractFileEngine::TriStateResult

Static Public Member Functions

static bool isCaseSensitive (const QFileSystemEntry &entry, QFileSystemMetaData &data)
static QFileSystemEntry getLinkTarget (const QFileSystemEntry &link, QFileSystemMetaData &data)
static QFileSystemEntry getRawLinkPath (const QFileSystemEntry &link, QFileSystemMetaData &data)
static QFileSystemEntry getJunctionTarget (const QFileSystemEntry &link, QFileSystemMetaData &data)
static QFileSystemEntry canonicalName (const QFileSystemEntry &entry, QFileSystemMetaData &data)
static QFileSystemEntry absoluteName (const QFileSystemEntry &entry)
static QByteArray id (const QFileSystemEntry &entry)
static QFileSystemNativeId nativeId (const QFileSystemEntry &entry)
static QString resolveUserName (const QFileSystemEntry &entry, QFileSystemMetaData &data)
static QString resolveGroupName (const QFileSystemEntry &entry, QFileSystemMetaData &data)
static QString bundleName (const QFileSystemEntry &)
static bool fillMetaData (const QFileSystemEntry &entry, QFileSystemMetaData &data, QFileSystemMetaData::MetaDataFlags what)
static QString homePath ()
static QString rootPath ()
static QString tempPath ()
static bool createDirectory (const QFileSystemEntry &entry, bool createParents, std::optional< QFile::Permissions > permissions=std::nullopt)
static bool mkdir (const QFileSystemEntry &entry, std::optional< QFile::Permissions > permissions=std::nullopt)
static bool mkpath (const QFileSystemEntry &entry, std::optional< QFile::Permissions > permissions=std::nullopt)
static bool removeDirectory (const QFileSystemEntry &entry, bool removeEmptyParents)
static bool rmdir (const QFileSystemEntry &entry)
static bool rmpath (const QFileSystemEntry &entry)
static bool supportsRmdirRecursively () noexcept
static bool rmdirRecursively (const QFileSystemEntry &entry, QSystemError &error)
static bool createLink (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
static bool copyFile (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
static bool supportsMoveFileToTrash ()
static bool moveFileToTrash (const QFileSystemEntry &source, QFileSystemEntry &newLocation, QSystemError &error)
static bool renameFile (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
static bool renameOverwriteFile (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
static bool removeFile (const QFileSystemEntry &entry, QSystemError &error)
static bool setPermissions (const QFileSystemEntry &entry, QFile::Permissions permissions, QSystemError &error)
static bool setFileTime (const QFileSystemEntry &entry, const QDateTime &newDate, QFile::FileTime whatTime, QSystemError &error)
static bool setCurrentPath (const QFileSystemEntry &entry)
static QFileSystemEntry currentPath ()
static std::unique_ptr< QAbstractFileEngine > createLegacyEngine (QFileSystemEntry &entry, QFileSystemMetaData &data)
static std::unique_ptr< QAbstractFileEngine > createLegacyEngine (const QString &fileName)

Detailed Description

QFileSystemEngine offers OS-independent API for native system library methods, which work with files on physical disk drives; using such methods directly is faster than using a custom file engine (see QAbstractFileEngine and its sub-classes). Typically, you need a custom file engine when working with virtual file systems (for example QResource). Various Qt classes, for example QDir, QFile, and QFileInfo, can handle both types of files by detecting the file path scheme, for example, file:///, :/someresource (QResource).

See also
QAbstractFileEngine, QAbstractFileEngineHandler, QFSFileEngine, QResourceFileEngine

Definition at line 84 of file qfilesystemengine_p.h.

Member Typedef Documentation

◆ TriStateResult

using QFileSystemEngine::TriStateResult = QAbstractFileEngine::TriStateResult

Definition at line 87 of file qfilesystemengine_p.h.

Member Function Documentation

◆ absoluteName()

QFileSystemEntry QFileSystemEngine::absoluteName ( const QFileSystemEntry & entry)
static

Definition at line 754 of file qfilesystemengine_unix.cpp.

◆ bundleName()

QString QFileSystemEngine::bundleName ( const QFileSystemEntry & )
inlinestatic

Definition at line 110 of file qfilesystemengine_p.h.

◆ canonicalName()

QFileSystemEntry QFileSystemEngine::canonicalName ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 714 of file qfilesystemengine_unix.cpp.

◆ copyFile()

bool QFileSystemEngine::copyFile ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1893 of file qfilesystemengine_unix.cpp.

◆ createDirectory()

bool QFileSystemEngine::createDirectory ( const QFileSystemEntry & entry,
bool createParents,
std::optional< QFile::Permissions > permissions = std::nullopt )
inlinestatic

Definition at line 146 of file qfilesystemengine_p.h.

◆ createLegacyEngine() [1/2]

std::unique_ptr< QAbstractFileEngine > QFileSystemEngine::createLegacyEngine ( const QString & fileName)
static

Definition at line 205 of file qfilesystemengine.cpp.

◆ createLegacyEngine() [2/2]

std::unique_ptr< QAbstractFileEngine > QFileSystemEngine::createLegacyEngine ( QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Resolves the entry (see QDir::searchPaths) and returns an engine for it, but never a QFSFileEngine.

Returns a file engine that can be used to access the entry. Returns 0 if QFileSystemEngine API should be used to query and interact with the file system object.

Definition at line 190 of file qfilesystemengine.cpp.

◆ createLink()

bool QFileSystemEngine::createLink ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1373 of file qfilesystemengine_unix.cpp.

◆ currentPath()

QFileSystemEntry QFileSystemEngine::currentPath ( )
static

Definition at line 2111 of file qfilesystemengine_unix.cpp.

◆ fillMetaData()

bool QFileSystemEngine::fillMetaData ( const QFileSystemEntry & entry,
QFileSystemMetaData & data,
QFileSystemMetaData::MetaDataFlags what )
static

Definition at line 424 of file qfilesystemengine_unix.cpp.

◆ getJunctionTarget()

QFileSystemEntry QFileSystemEngine::getJunctionTarget ( const QFileSystemEntry & link,
QFileSystemMetaData & data )
static

Definition at line 243 of file qfilesystemengine.cpp.

◆ getLinkTarget()

QFileSystemEntry QFileSystemEngine::getLinkTarget ( const QFileSystemEntry & link,
QFileSystemMetaData & data )
static

Definition at line 645 of file qfilesystemengine_unix.cpp.

◆ getRawLinkPath()

QFileSystemEntry QFileSystemEngine::getRawLinkPath ( const QFileSystemEntry & link,
QFileSystemMetaData & data )
static

Definition at line 704 of file qfilesystemengine_unix.cpp.

◆ homePath()

QString QFileSystemEngine::homePath ( )
static

Definition at line 2058 of file qfilesystemengine_unix.cpp.

◆ id()

QByteArray QFileSystemEngine::id ( const QFileSystemEntry & entry)
inlinestatic

Definition at line 97 of file qfilesystemengine_p.h.

◆ isCaseSensitive()

bool QFileSystemEngine::isCaseSensitive ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 2140 of file qfilesystemengine_unix.cpp.

◆ mkdir()

bool QFileSystemEngine::mkdir ( const QFileSystemEntry & entry,
std::optional< QFile::Permissions > permissions = std::nullopt )
static

Definition at line 1330 of file qfilesystemengine_unix.cpp.

◆ mkpath()

bool QFileSystemEngine::mkpath ( const QFileSystemEntry & entry,
std::optional< QFile::Permissions > permissions = std::nullopt )
static

Definition at line 1320 of file qfilesystemengine_unix.cpp.

◆ moveFileToTrash()

bool QFileSystemEngine::moveFileToTrash ( const QFileSystemEntry & source,
QFileSystemEntry & newLocation,
QSystemError & error )
static

Definition at line 31 of file qfilesystemengine_mac.mm.

◆ nativeId()

QFileSystemNativeId QFileSystemEngine::nativeId ( const QFileSystemEntry & entry)
static

Definition at line 807 of file qfilesystemengine_unix.cpp.

◆ removeDirectory()

bool QFileSystemEngine::removeDirectory ( const QFileSystemEntry & entry,
bool removeEmptyParents )
inlinestatic

Definition at line 159 of file qfilesystemengine_p.h.

◆ removeFile()

bool QFileSystemEngine::removeFile ( const QFileSystemEntry & entry,
QSystemError & error )
static

Definition at line 1993 of file qfilesystemengine_unix.cpp.

◆ renameFile()

bool QFileSystemEngine::renameFile ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1902 of file qfilesystemengine_unix.cpp.

◆ renameOverwriteFile()

bool QFileSystemEngine::renameOverwriteFile ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1981 of file qfilesystemengine_unix.cpp.

◆ resolveGroupName()

QString QFileSystemEngine::resolveGroupName ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 228 of file qfilesystemengine.cpp.

◆ resolveUserName()

QString QFileSystemEngine::resolveUserName ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 213 of file qfilesystemengine.cpp.

◆ rmdir()

bool QFileSystemEngine::rmdir ( const QFileSystemEntry & entry)
static

Definition at line 1345 of file qfilesystemengine_unix.cpp.

◆ rmdirRecursively()

bool QFileSystemEngine::rmdirRecursively ( const QFileSystemEntry & entry,
QSystemError & error )
static

Definition at line 1778 of file qfilesystemengine_unix.cpp.

◆ rmpath()

bool QFileSystemEngine::rmpath ( const QFileSystemEntry & entry)
static

Definition at line 1352 of file qfilesystemengine_unix.cpp.

◆ rootPath()

QString QFileSystemEngine::rootPath ( )
static

Definition at line 2066 of file qfilesystemengine_unix.cpp.

◆ setCurrentPath()

bool QFileSystemEngine::setCurrentPath ( const QFileSystemEntry & entry)
static

Definition at line 2104 of file qfilesystemengine_unix.cpp.

◆ setFileTime()

bool QFileSystemEngine::setFileTime ( const QFileSystemEntry & entry,
const QDateTime & newDate,
QFile::FileTime whatTime,
QSystemError & error )
static

Definition at line 2027 of file qfilesystemengine_unix.cpp.

◆ setPermissions()

bool QFileSystemEngine::setPermissions ( const QFileSystemEntry & entry,
QFile::Permissions permissions,
QSystemError & error )
static

Definition at line 2004 of file qfilesystemengine_unix.cpp.

◆ supportsMoveFileToTrash()

bool QFileSystemEngine::supportsMoveFileToTrash ( )
static

Definition at line 25 of file qfilesystemengine_mac.mm.

◆ supportsRmdirRecursively()

bool QFileSystemEngine::supportsRmdirRecursively ( )
staticnoexcept

Definition at line 1772 of file qfilesystemengine_unix.cpp.

◆ tempPath()

QString QFileSystemEngine::tempPath ( )
static

Definition at line 2082 of file qfilesystemengine_unix.cpp.

The documentation for this class was generated from the following files: