#include <qrandomaccessasyncfile_p.h>

Inheritance diagram for QRandomAccessAsyncFile:

Collaboration diagram for QRandomAccessAsyncFile:

Public Member Functions
	QRandomAccessAsyncFile (QObject *parent=nullptr)
	~QRandomAccessAsyncFile () override
void	close ()
qint64	size () const
QIOOperation *	open (const QString &filePath, QIODeviceBase::OpenMode mode)
QIOOperation *	flush ()
QIOReadOperation *	read (qint64 offset, qint64 maxSize)
QIOWriteOperation *	write (qint64 offset, const QByteArray &data)
QIOWriteOperation *	write (qint64 offset, QByteArray &&data)
QIOVectoredReadOperation *	readInto (qint64 offset, QSpan< std::byte > buffer)
QIOVectoredWriteOperation *	writeFrom (qint64 offset, QSpan< const std::byte > buffer)
QIOVectoredReadOperation *	readInto (qint64 offset, QSpan< const QSpan< std::byte > > buffers)
QIOVectoredWriteOperation *	writeFrom (qint64 offset, QSpan< const QSpan< const std::byte > > buffers)
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 27 of file qrandomaccessasyncfile_p.h.

Constructor & Destructor Documentation

◆ QRandomAccessAsyncFile()

QT_BEGIN_NAMESPACE QRandomAccessAsyncFile::QRandomAccessAsyncFile ( QObject * parent = nullptr )

explicit

Definition at line 10 of file qrandomaccessasyncfile.cpp.

◆ ~QRandomAccessAsyncFile()

QRandomAccessAsyncFile::~QRandomAccessAsyncFile ( )

override

Definition at line 16 of file qrandomaccessasyncfile.cpp.

Member Function Documentation

◆ close()

void QRandomAccessAsyncFile::close ( )

Definition at line 21 of file qrandomaccessasyncfile.cpp.

◆ flush()

QIOOperation * QRandomAccessAsyncFile::flush ( )

nodiscard

Flushes any buffered data to the file.

returns-qiooperation

Definition at line 53 of file qrandomaccessasyncfile.cpp.

Referenced by testing.tools.encode_pdf_filter._SinkPdfStream::close().

Here is the caller graph for this function:

◆ open()

QIOOperation * QRandomAccessAsyncFile::open	(	const QString &	filePath,
		QIODeviceBase::OpenMode	mode )

nodiscard

Attempts to open the file filePath with mode mode.

returns-qiooperation

Definition at line 40 of file qrandomaccessasyncfile.cpp.

◆ read()

QIOReadOperation * QRandomAccessAsyncFile::read	(	qint64	offset,
		qint64	maxSize )

nodiscard

\internal

Reads at maximum \a maxSize bytes, starting from \a offset.

The data is written to the internal buffer managed by the returned
QIOOperation object.

! [returns-qiooperation] Returns a QIOOperation object that would emit a QIOOperation::finished() signal once the operation is complete. ! [returns-qiooperation]

Definition at line 72 of file qrandomaccessasyncfile.cpp.

◆ readInto() [1/2]

QIOVectoredReadOperation * QRandomAccessAsyncFile::readInto	(	qint64	offset,
		QSpan< const QSpan< std::byte > >	buffers )

nodiscard

Reads the data from the file, starting from offset, and stores it into buffers.

The amount of bytes to be read from the file is determined by the sum of sizes of all buffers. Note that the actual amount of read bytes can be less than that.

This operation does not take ownership of the provided buffers, so it is the user's responsibility to make sure that the buffers are valid until the returned QIOOperation completes.

Note: The buffers might be populated from different threads, so the user application should not access them until the returned QIOOperation completes.

returns-qiooperation

Definition at line 129 of file qrandomaccessasyncfile.cpp.

◆ readInto() [2/2]

QIOVectoredReadOperation * QRandomAccessAsyncFile::readInto	(	qint64	offset,
		QSpan< std::byte >	buffer )

nodiscard

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Reads the data from the file, starting from offset, and stores it into buffer.

The amount of bytes to be read from the file is determined by the size of the buffer. Note that the actual amount of read bytes can be less than that.

This operation does not take ownership of the provided buffer, so it is the user's responsibility to make sure that the buffer is valid until the returned QIOOperation completes.

Note: The buffer might be populated from different threads, so the user application should not access it until the returned QIOOperation completes.

returns-qiooperation

Definition at line 103 of file qrandomaccessasyncfile.cpp.

◆ size()

qint64 QRandomAccessAsyncFile::size ( ) const

Definition at line 27 of file qrandomaccessasyncfile.cpp.

◆ write() [1/2]

QIOWriteOperation * QRandomAccessAsyncFile::write	(	qint64	offset,
		const QByteArray &	data )

nodiscard

Writes data into the file, starting from offset.

The data array is copied into the returned QIOOperation object.

returns-qiooperation

Definition at line 144 of file qrandomaccessasyncfile.cpp.

◆ write() [2/2]

QIOWriteOperation * QRandomAccessAsyncFile::write	(	qint64	offset,
		QByteArray &&	data )

nodiscard

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Writes data into the file, starting from offset.

The data array is moved into the returned QIOOperation object.

returns-qiooperation

Definition at line 160 of file qrandomaccessasyncfile.cpp.

◆ writeFrom() [1/2]

QIOVectoredWriteOperation * QRandomAccessAsyncFile::writeFrom	(	qint64	offset,
		QSpan< const QSpan< const std::byte > >	buffers )

nodiscard

Writes the content of buffers into the file, starting from offset.

This operation does not take ownership of the provided buffers, so it is the user's responsibility to make sure that the buffers are valid until the returned QIOOperation completes.

Note: The buffers might be accessed from different threads, so the user application should not modify them until the returned QIOOperation completes.

Definition at line 200 of file qrandomaccessasyncfile.cpp.

◆ writeFrom() [2/2]

QIOVectoredWriteOperation * QRandomAccessAsyncFile::writeFrom	(	qint64	offset,
		QSpan< const std::byte >	buffer )

nodiscard

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Writes the content of buffer into the file, starting from offset.

This operation does not take ownership of the provided buffer, so it is the user's responsibility to make sure that the buffer is valid until the returned QIOOperation completes.

Note: The buffer might be accessed from different threads, so the user application should not modify it until the returned QIOOperation completes.

Definition at line 180 of file qrandomaccessasyncfile.cpp.

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

qtbase/src/corelib/io/qrandomaccessasyncfile_p.h (0f41ca136b50b3180ea3176a16cc7644029ce377)
qtbase/src/corelib/io/qrandomaccessasyncfile.cpp (0f41ca136b50b3180ea3176a16cc7644029ce377)

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QRandomAccessAsyncFile()

◆ ~QRandomAccessAsyncFile()

Member Function Documentation

◆ close()

◆ flush()

◆ open()

◆ read()

◆ readInto() [1/2]

◆ readInto() [2/2]

◆ size()

◆ write() [1/2]

◆ write() [2/2]

◆ writeFrom() [1/2]

◆ writeFrom() [2/2]