Struct qt_core::QTemporaryFile

#[repr(C)]pub struct QTemporaryFile { /* fields omitted */ }

The QTemporaryFile class is an I/O device that operates on temporary files.

C++ class: QTemporaryFile.

C++ documentation:

The QTemporaryFile class is an I/O device that operates on temporary files.

QTemporaryFile is used to create unique temporary files safely. The file itself is created by calling open(). The name of the temporary file is guaranteed to be unique (i.e., you are guaranteed to not overwrite an existing file), and the file will subsequently be removed upon destruction of the QTemporaryFile object. This is an important technique that avoids data corruption for applications that store data in temporary files. The file name is either auto-generated, or created based on a template, which is passed to QTemporaryFile's constructor.

Example:

      // Within a function/method...
      QTemporaryFile file;
      if (file.open()) {
          // file.fileName() returns the unique file name
      }
      // The QTemporaryFile destructor removes the temporary file
      // as it goes out of scope.

Reopening a QTemporaryFile after calling close() is safe. For as long as the QTemporaryFile object itself is not destroyed, the unique temporary file will exist and be kept open internally by QTemporaryFile.

The file name of the temporary file can be found by calling fileName(). Note that this is only defined after the file is first opened; the function returns an empty string before this.

A temporary file will have some static part of the name and some part that is calculated to be unique. The default filename will be determined from QCoreApplication::applicationName() (otherwise qt_temp) and will be placed into the temporary path as returned by QDir::tempPath(). If you specify your own filename, a relative file path will not be placed in the temporary directory by default, but be relative to the current working directory.

Specified filenames can contain the following template XXXXXX (six upper case "X" characters), which will be replaced by the auto-generated portion of the filename. Note that the template is case sensitive. If the template is not present in the filename, QTemporaryFile appends the generated part to the filename given.

Methods

impl QTemporaryFile

pub unsafe fn auto_remove(&self) -> bool

Returns true if the QTemporaryFile is in auto remove mode. Auto-remove mode will automatically delete the filename from disk upon destruction. This makes it very easy to create your QTemporaryFile object on the stack, fill it with data, read from it, and finally on function return it will automatically clean up after itself.

Calls C++ function: bool QTemporaryFile::autoRemove() const.

C++ documentation:

Returns true if the QTemporaryFile is in auto remove mode. Auto-remove mode will automatically delete the filename from disk upon destruction. This makes it very easy to create your QTemporaryFile object on the stack, fill it with data, read from it, and finally on function return it will automatically clean up after itself.

Auto-remove is on by default.

See also setAutoRemove() and remove().

pub unsafe fn create_local_file_q_string(
    file_name: impl CastInto<Ref<QString>>
) -> QPtr<QTemporaryFile>

Use QTemporaryFile::createNativeFile(QFile &file) instead.

Calls C++ function: static QTemporaryFile* QTemporaryFile::createLocalFile(const QString& fileName).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for static QTemporaryFile *QTemporaryFile::createLocalFile(QFile &file):

Use QTemporaryFile::createNativeFile(QFile &file) instead.

pub unsafe fn create_local_file_q_file(
    file: impl CastInto<Ref<QFile>>
) -> QPtr<QTemporaryFile>

Use QTemporaryFile::createNativeFile(QFile &file) instead.

Calls C++ function: static QTemporaryFile* QTemporaryFile::createLocalFile(QFile& file).

C++ documentation:

Use QTemporaryFile::createNativeFile(QFile &file) instead.

pub unsafe fn create_native_file_q_string(
    file_name: impl CastInto<Ref<QString>>
) -> QPtr<QTemporaryFile>

This is an overloaded function.

Calls C++ function: static QTemporaryFile* QTemporaryFile::createNativeFile(const QString& fileName).

C++ documentation:

This is an overloaded function.

Works on the given fileName rather than an existing QFile object.

pub unsafe fn create_native_file_q_file(
    file: impl CastInto<Ref<QFile>>
) -> QPtr<QTemporaryFile>

If file is not already a native file, then a QTemporaryFile is created in QDir::tempPath(), the contents of file is copied into it, and a pointer to the temporary file is returned. Does nothing and returns 0 if file is already a native file.

Calls C++ function: static QTemporaryFile* QTemporaryFile::createNativeFile(QFile& file).

C++ documentation:

If file is not already a native file, then a QTemporaryFile is created in QDir::tempPath(), the contents of file is copied into it, and a pointer to the temporary file is returned. Does nothing and returns 0 if file is already a native file.

For example:

QFile f(":/resources/file.txt");
QTemporaryFile::createNativeFile(f); // Returns a pointer to a temporary file
QFile f("/users/qt/file.txt");
QTemporaryFile::createNativeFile(f); // Returns 0

See also QFileInfo::isNativePath().

pub unsafe fn file_name(&self) -> CppBox<QString>

Reimplemented from QFileDevice::fileName().

Calls C++ function: virtual QString QTemporaryFile::fileName() const.

C++ documentation:

Reimplemented from QFileDevice::fileName().

Returns the complete unique filename backing the QTemporaryFile object. This string is null before the QTemporaryFile is opened, afterwards it will contain the fileTemplate() plus additional characters to make it unique.

See also fileTemplate().

pub unsafe fn file_template(&self) -> CppBox<QString>

Returns the set file template. The default file template will be called qcoreappname.XXXXXX and be placed in QDir::tempPath().

Calls C++ function: QString QTemporaryFile::fileTemplate() const.

C++ documentation:

Returns the set file template. The default file template will be called qcoreappname.XXXXXX and be placed in QDir::tempPath().

See also setFileTemplate().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QTemporaryFile::metaObject() const.

pub unsafe fn new() -> QBox<QTemporaryFile>

Constructs a QTemporaryFile using as file template the application name returned by QCoreApplication::applicationName() (otherwise qt_temp) followed by ".XXXXXX". The file is stored in the system's temporary directory, QDir::tempPath().

Calls C++ function: [constructor] void QTemporaryFile::QTemporaryFile().

C++ documentation:

Constructs a QTemporaryFile using as file template the application name returned by QCoreApplication::applicationName() (otherwise qt_temp) followed by ".XXXXXX". The file is stored in the system's temporary directory, QDir::tempPath().

See also setFileTemplate() and QDir::tempPath().

pub unsafe fn from_q_string(
    template_name: impl CastInto<Ref<QString>>
) -> QBox<QTemporaryFile>

Constructs a QTemporaryFile with a template filename of templateName. Upon opening the temporary file this will be used to create a unique filename.

Calls C++ function: [constructor] void QTemporaryFile::QTemporaryFile(const QString& templateName).

C++ documentation:

Constructs a QTemporaryFile with a template filename of templateName. Upon opening the temporary file this will be used to create a unique filename.

If the templateName does not contain XXXXXX it will automatically be appended and used as the dynamic portion of the filename.

If templateName is a relative path, the path will be relative to the current working directory. You can use QDir::tempPath() to construct templateName if you want use the system's temporary directory.

See also open() and fileTemplate().

pub unsafe fn from_q_object(
    parent: impl CastInto<Ptr<QObject>>
) -> QBox<QTemporaryFile>

Constructs a QTemporaryFile (with the given parent) using as file template the application name returned by QCoreApplication::applicationName() (otherwise qt_temp) followed by ".XXXXXX". The file is stored in the system's temporary directory, QDir::tempPath().

Calls C++ function: [constructor] void QTemporaryFile::QTemporaryFile(QObject* parent).

C++ documentation:

Constructs a QTemporaryFile (with the given parent) using as file template the application name returned by QCoreApplication::applicationName() (otherwise qt_temp) followed by ".XXXXXX". The file is stored in the system's temporary directory, QDir::tempPath().

See also setFileTemplate().

pub unsafe fn from_q_string_q_object(
    template_name: impl CastInto<Ref<QString>>,
    parent: impl CastInto<Ptr<QObject>>
) -> QBox<QTemporaryFile>

Constructs a QTemporaryFile with a template filename of templateName and the specified parent. Upon opening the temporary file this will be used to create a unique filename.

Calls C++ function: [constructor] void QTemporaryFile::QTemporaryFile(const QString& templateName, QObject* parent).

C++ documentation:

Constructs a QTemporaryFile with a template filename of templateName and the specified parent. Upon opening the temporary file this will be used to create a unique filename.

If the templateName does not contain XXXXXX it will automatically be appended and used as the dynamic portion of the filename.

If templateName is a relative path, the path will be relative to the current working directory. You can use QDir::tempPath() to construct templateName if you want use the system's temporary directory.

See also open() and fileTemplate().

pub unsafe fn open(&self) -> bool

A QTemporaryFile will always be opened in QIODevice::ReadWrite mode, this allows easy access to the data in the file. This function will return true upon success and will set the fileName() to the unique filename used.

Calls C++ function: bool QTemporaryFile::open().

C++ documentation:

A QTemporaryFile will always be opened in QIODevice::ReadWrite mode, this allows easy access to the data in the file. This function will return true upon success and will set the fileName() to the unique filename used.

See also fileName().

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int QTemporaryFile::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* QTemporaryFile::qt_metacast(const char* arg1).

pub unsafe fn rename(&self, new_name: impl CastInto<Ref<QString>>) -> bool

Calls C++ function: bool QTemporaryFile::rename(const QString& newName).

pub unsafe fn set_auto_remove(&self, b: bool)

Sets the QTemporaryFile into auto-remove mode if b is true.

Calls C++ function: void QTemporaryFile::setAutoRemove(bool b).

C++ documentation:

Sets the QTemporaryFile into auto-remove mode if b is true.

Auto-remove is on by default.

See also autoRemove() and remove().

pub unsafe fn set_file_template(&self, name: impl CastInto<Ref<QString>>)

Sets the static portion of the file name to name. If the file template contains XXXXXX that will automatically be replaced with the unique part of the filename, otherwise a filename will be determined automatically based on the static portion specified.

Calls C++ function: void QTemporaryFile::setFileTemplate(const QString& name).

C++ documentation:

Sets the static portion of the file name to name. If the file template contains XXXXXX that will automatically be replaced with the unique part of the filename, otherwise a filename will be determined automatically based on the static portion specified.

If name contains a relative file path, the path will be relative to the current working directory. You can use QDir::tempPath() to construct name if you want use the system's temporary directory.

See also fileTemplate().

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QTemporaryFile::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QTemporaryFile::trUtf8(const char* s, const char* c, int n).

Methods from Deref<Target = QFile>

pub unsafe fn copy_mut(&self, new_name: impl CastInto<Ref<QString>>) -> bool

Copies the file currently specified by fileName() to a file called newName. Returns true if successful; otherwise returns false.

Calls C++ function: bool QFile::copy(const QString& newName).

C++ documentation:

Copies the file currently specified by fileName() to a file called newName. Returns true if successful; otherwise returns false.

Note that if a file with the name newName already exists, copy() returns false (i.e. QFile will not overwrite it).

The source file is closed before it is copied.

See also setFileName().

pub unsafe fn exists_0a(&self) -> bool

This is an overloaded function.

Calls C++ function: bool QFile::exists() const.

C++ documentation:

This is an overloaded function.

Returns true if the file specified by fileName() exists; otherwise returns false.

See also fileName() and setFileName().

pub unsafe fn file_name(&self) -> CppBox<QString>

Reimplemented from QFileDevice::fileName().

Calls C++ function: virtual QString QFile::fileName() const.

C++ documentation:

Reimplemented from QFileDevice::fileName().

Returns the name set by setFileName() or to the QFile constructors.

See also setFileName() and QFileInfo::fileName().

pub unsafe fn link_mut(&self, new_name: impl CastInto<Ref<QString>>) -> bool

Creates a link named linkName that points to the file currently specified by fileName(). What a link is depends on the underlying filesystem (be it a shortcut on Windows or a symbolic link on Unix). Returns true if successful; otherwise returns false.

Calls C++ function: bool QFile::link(const QString& newName).

C++ documentation:

Creates a link named linkName that points to the file currently specified by fileName(). What a link is depends on the underlying filesystem (be it a shortcut on Windows or a symbolic link on Unix). Returns true if successful; otherwise returns false.

This function will not overwrite an already existing entity in the file system; in this case, link() will return false and set error() to return RenameError.

Note: To create a valid link on Windows, linkName must have a .lnk file extension.

See also setFileName().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QFile::metaObject() const.

pub unsafe fn open_1a(&self, flags: QFlags<OpenModeFlag>) -> bool

Reimplemented from QIODevice::open().

Calls C++ function: virtual bool QFile::open(QFlags<QIODevice::OpenModeFlag> flags).

C++ documentation:

Reimplemented from QIODevice::open().

Opens the file using OpenMode mode, returning true if successful; otherwise false.

The mode must be QIODevice::ReadOnly, QIODevice::WriteOnly, or QIODevice::ReadWrite. It may also have additional flags, such as QIODevice::Text and QIODevice::Unbuffered.

Note: In WriteOnly or ReadWrite mode, if the relevant file does not already exist, this function will try to create a new file before opening it.

See also QIODevice::OpenMode and setFileName().

pub unsafe fn open_3a(
    &self,
    fd: c_int,
    io_flags: QFlags<OpenModeFlag>,
    handle_flags: QFlags<FileHandleFlag>
) -> bool

This is an overloaded function.

Calls C++ function: bool QFile::open(int fd, QFlags<QIODevice::OpenModeFlag> ioFlags, QFlags<QFileDevice::FileHandleFlag> handleFlags = …).

C++ documentation:

This is an overloaded function.

Opens the existing file descriptor fd in the given mode. handleFlags may be used to specify additional options. Returns true if successful; otherwise returns false.

When a QFile is opened using this function, behaviour of close() is controlled by the AutoCloseHandle flag. If AutoCloseHandle is specified, and this function succeeds, then calling close() closes the adopted handle. Otherwise, close() does not actually close the file, but only flushes it.

The QFile that is opened using this function is automatically set to be in raw mode; this means that the file input/output functions are slow. If you run into performance issues, you should try to use one of the other open functions.

Warning: If fd is not a regular file, e.g, it is 0 (stdin), 1 (stdout), or 2 (stderr), you may not be able to seek(). In those cases, size() returns 0. See QIODevice::isSequential() for more information.

Warning: Since this function opens the file without specifying the file name, you cannot use this QFile with a QFileInfo.

See also close().

pub unsafe fn open_2a(&self, fd: c_int, io_flags: QFlags<OpenModeFlag>) -> bool

This is an overloaded function.

Calls C++ function: bool QFile::open(int fd, QFlags<QIODevice::OpenModeFlag> ioFlags).

C++ documentation:

This is an overloaded function.

Opens the existing file descriptor fd in the given mode. handleFlags may be used to specify additional options. Returns true if successful; otherwise returns false.

When a QFile is opened using this function, behaviour of close() is controlled by the AutoCloseHandle flag. If AutoCloseHandle is specified, and this function succeeds, then calling close() closes the adopted handle. Otherwise, close() does not actually close the file, but only flushes it.

The QFile that is opened using this function is automatically set to be in raw mode; this means that the file input/output functions are slow. If you run into performance issues, you should try to use one of the other open functions.

Warning: If fd is not a regular file, e.g, it is 0 (stdin), 1 (stdout), or 2 (stderr), you may not be able to seek(). In those cases, size() returns 0. See QIODevice::isSequential() for more information.

Warning: Since this function opens the file without specifying the file name, you cannot use this QFile with a QFileInfo.

See also close().

pub unsafe fn permissions_0a(&self) -> QFlags<Permission>

Reimplemented from QFileDevice::permissions().

Calls C++ function: virtual QFlags<QFileDevice::Permission> QFile::permissions() const.

C++ documentation:

Reimplemented from QFileDevice::permissions().

See also setPermissions().

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int QFile::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* QFile::qt_metacast(const char* arg1).

pub unsafe fn read_link_0a(&self) -> CppBox<QString>

Use symLinkTarget() instead.

Calls C++ function: QString QFile::readLink() const.

C++ documentation:

Use symLinkTarget() instead.

pub unsafe fn remove_mut(&self) -> bool

Removes the file specified by fileName(). Returns true if successful; otherwise returns false.

Calls C++ function: bool QFile::remove().

C++ documentation:

Removes the file specified by fileName(). Returns true if successful; otherwise returns false.

The file is closed before it is removed.

See also setFileName().

pub unsafe fn rename_mut(&self, new_name: impl CastInto<Ref<QString>>) -> bool

Renames the file currently specified by fileName() to newName. Returns true if successful; otherwise returns false.

Calls C++ function: bool QFile::rename(const QString& newName).

C++ documentation:

Renames the file currently specified by fileName() to newName. Returns true if successful; otherwise returns false.

If a file with the name newName already exists, rename() returns false (i.e., QFile will not overwrite it).

The file is closed before it is renamed.

If the rename operation fails, Qt will attempt to copy this file's contents to newName, and then remove this file, keeping only newName. If that copy operation fails or this file can't be removed, the destination file newName is removed to restore the old state.

See also setFileName().

pub unsafe fn resize_mut(&self, sz: i64) -> bool

Reimplemented from QFileDevice::resize().

Calls C++ function: virtual bool QFile::resize(qint64 sz).

C++ documentation:

Reimplemented from QFileDevice::resize().

pub unsafe fn set_file_name(&self, name: impl CastInto<Ref<QString>>)

Sets the name of the file. The name can have no path, a relative path, or an absolute path.

Calls C++ function: void QFile::setFileName(const QString& name).

C++ documentation:

Sets the name of the file. The name can have no path, a relative path, or an absolute path.

Do not call this function if the file has already been opened.

If the file name has no path or a relative path, the path used will be the application's current directory path at the time of the open() call.

Example:

QFile file;
QDir::setCurrent("/tmp");
file.setFileName("readme.txt");
QDir::setCurrent("/home");
file.open(QIODevice::ReadOnly);      // opens "/home/readme.txt" under Unix

Note that the directory separator "/" works for all operating systems supported by Qt.

See also fileName(), QFileInfo, and QDir.

pub unsafe fn set_permissions_mut(
    &self,
    permission_spec: QFlags<Permission>
) -> bool

Reimplemented from QFileDevice::setPermissions().

Calls C++ function: virtual bool QFile::setPermissions(QFlags<QFileDevice::Permission> permissionSpec).

C++ documentation:

Reimplemented from QFileDevice::setPermissions().

Sets the permissions for the file to the permissions specified. Returns true if successful, or false if the permissions cannot be modified.

Warning: This function does not manipulate ACLs, which may limit its effectiveness.

See also permissions() and setFileName().

pub unsafe fn size(&self) -> i64

Reimplemented from QIODevice::size().

Calls C++ function: virtual qint64 QFile::size() const.

C++ documentation:

Reimplemented from QIODevice::size().

pub unsafe fn sym_link_target_0a(&self) -> CppBox<QString>

This is an overloaded function.

Calls C++ function: QString QFile::symLinkTarget() const.

C++ documentation:

This is an overloaded function.

Returns the absolute path of the file or directory a symlink (or shortcut on Windows) points to, or a an empty string if the object isn't a symbolic link.

This name may not represent an existing file; it is only a string. QFile::exists() returns true if the symlink points to an existing file.

This function was introduced in Qt 4.2.

See also fileName() and setFileName().

Trait Implementations

impl CppDeletable for QTemporaryFile

unsafe fn delete(&self)

Destroys the temporary file object, the file is automatically closed if necessary and if in auto remove mode it will automatically delete the file.

Calls C++ function: virtual [destructor] void QTemporaryFile::~QTemporaryFile().

C++ documentation:

Destroys the temporary file object, the file is automatically closed if necessary and if in auto remove mode it will automatically delete the file.

See also autoRemove().

impl Deref for QTemporaryFile

type Target = QFile

The resulting type after dereferencing.

fn deref(&self) -> &QFile

Calls C++ function: QFile* static_cast<QFile*>(QTemporaryFile* ptr).

impl DynamicCast<QTemporaryFile> for QFile

unsafe fn dynamic_cast(ptr: Ptr<QFile>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* dynamic_cast<QTemporaryFile*>(QFile* ptr).

impl DynamicCast<QTemporaryFile> for QFileDevice

unsafe fn dynamic_cast(ptr: Ptr<QFileDevice>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* dynamic_cast<QTemporaryFile*>(QFileDevice* ptr).

impl DynamicCast<QTemporaryFile> for QIODevice

unsafe fn dynamic_cast(ptr: Ptr<QIODevice>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* dynamic_cast<QTemporaryFile*>(QIODevice* ptr).

impl DynamicCast<QTemporaryFile> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* dynamic_cast<QTemporaryFile*>(QObject* ptr).

impl StaticDowncast<QTemporaryFile> for QFile

unsafe fn static_downcast(ptr: Ptr<QFile>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* static_cast<QTemporaryFile*>(QFile* ptr).

impl StaticDowncast<QTemporaryFile> for QFileDevice

unsafe fn static_downcast(ptr: Ptr<QFileDevice>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* static_cast<QTemporaryFile*>(QFileDevice* ptr).

impl StaticDowncast<QTemporaryFile> for QIODevice

unsafe fn static_downcast(ptr: Ptr<QIODevice>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* static_cast<QTemporaryFile*>(QIODevice* ptr).

impl StaticDowncast<QTemporaryFile> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QTemporaryFile>

Calls C++ function: QTemporaryFile* static_cast<QTemporaryFile*>(QObject* ptr).

impl StaticUpcast<QFile> for QTemporaryFile

unsafe fn static_upcast(ptr: Ptr<QTemporaryFile>) -> Ptr<QFile>

Calls C++ function: QFile* static_cast<QFile*>(QTemporaryFile* ptr).

impl StaticUpcast<QFileDevice> for QTemporaryFile

unsafe fn static_upcast(ptr: Ptr<QTemporaryFile>) -> Ptr<QFileDevice>

Calls C++ function: QFileDevice* static_cast<QFileDevice*>(QTemporaryFile* ptr).

impl StaticUpcast<QIODevice> for QTemporaryFile

unsafe fn static_upcast(ptr: Ptr<QTemporaryFile>) -> Ptr<QIODevice>

Calls C++ function: QIODevice* static_cast<QIODevice*>(QTemporaryFile* ptr).

impl StaticUpcast<QObject> for QTemporaryFile

unsafe fn static_upcast(ptr: Ptr<QTemporaryFile>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QTemporaryFile* ptr).