cutelyst 3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::Upload Class Referencefinal

Cutelyst Upload handles file upload request More...

#include <Cutelyst/Upload>

Inheritance diagram for Cutelyst::Upload:

Public Member Functions

 Upload (UploadPrivate *prv)
QString contentType () const
QTemporaryFilecreateTemporaryFile (const QString &templateName=QString())
QString filename () const
Headers headers () const
QString name () const
virtual qint64 pos () const override
bool save (const QString &filename)
virtual bool seek (qint64 pos) override
virtual qint64 size () const override
Public Member Functions inherited from QIODevice
 QIODevice (QObject *parent)
void aboutToClose ()
virtual bool atEnd () const const
virtual qint64 bytesAvailable () const const
virtual qint64 bytesToWrite () const const
void bytesWritten (qint64 bytes)
virtual bool canReadLine () const const
void channelBytesWritten (int channel, qint64 bytes)
void channelReadyRead (int channel)
virtual void close ()
void commitTransaction ()
int currentReadChannel () const const
int currentWriteChannel () const const
QString errorString () const const
bool getChar (char *c)
bool isOpen () const const
bool isReadable () const const
virtual bool isSequential () const const
bool isTextModeEnabled () const const
bool isTransactionStarted () const const
bool isWritable () const const
virtual bool open (OpenMode mode)
OpenMode openMode () const const
qint64 peek (char *data, qint64 maxSize)
QByteArray peek (qint64 maxSize)
bool putChar (char c)
qint64 read (char *data, qint64 maxSize)
QByteArray read (qint64 maxSize)
QByteArray readAll ()
int readChannelCount () const const
void readChannelFinished ()
qint64 readLine (char *data, qint64 maxSize)
QByteArray readLine (qint64 maxSize)
void readyRead ()
virtual bool reset ()
void rollbackTransaction ()
void setCurrentReadChannel (int channel)
void setCurrentWriteChannel (int channel)
void setTextModeEnabled (bool enabled)
qint64 skip (qint64 maxSize)
void startTransaction ()
void ungetChar (char c)
virtual bool waitForBytesWritten (int msecs)
virtual bool waitForReadyRead (int msecs)
qint64 write (const char *data)
qint64 write (const char *data, qint64 maxSize)
qint64 write (const QByteArray &byteArray)
int writeChannelCount () const const
Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool event (QEvent *e)
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName, QPrivateSignal)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_DISABLE_COPY (Class)
 Q_DISABLE_COPY_MOVE (Class)
 Q_DISABLE_MOVE (Class)
 Q_EMIT Q_EMIT
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
 Q_GADGET Q_GADGET
 Q_INTERFACES (...)
 Q_INVOKABLE Q_INVOKABLE
 Q_NAMESPACE Q_NAMESPACE
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 Q_OBJECT Q_OBJECT
 Q_PROPERTY (...)
 Q_REVISION Q_REVISION
 Q_SET_OBJECT_NAME (Object)
 Q_SIGNAL Q_SIGNAL
 Q_SIGNALS Q_SIGNALS
 Q_SLOT Q_SLOT
 Q_SLOTS Q_SLOTS
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const

Protected Member Functions

virtual qint64 readData (char *data, qint64 maxlen) override
virtual qint64 readLineData (char *data, qint64 maxlen) override
virtual qint64 writeData (const char *data, qint64 maxSize) override
Protected Member Functions inherited from QIODevice
void setErrorString (const QString &str)
void setOpenMode (OpenMode openMode)
Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Additional Inherited Members

Public Types inherited from QIODevice
enum  OpenModeFlag
Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QIODevice
 Append
 ExistingOnly
 NewOnly
 NotOpen
typedef OpenMode
 ReadOnly
 ReadWrite
 Text
 Truncate
 Unbuffered
 WriteOnly
Public Attributes inherited from QObject
typedef QObjectList
Properties inherited from QObject
 objectName

Detailed Description

Definition at line 22 of file upload.h.

Constructor & Destructor Documentation

◆ Upload()

Upload::Upload ( UploadPrivate * prv)

This class provides access to client upload requests

Definition at line 154 of file upload.cpp.

References Upload(), QString::indexOf(), QString::mid(), and QIODevice::open().

Referenced by Upload(), contentType(), createTemporaryFile(), filename(), headers(), name(), pos(), readData(), readLineData(), save(), seek(), and size().

◆ ~Upload()

Upload::~Upload ( )
overridevirtual

Definition at line 179 of file upload.cpp.

Member Function Documentation

◆ contentType()

QString Upload::contentType ( ) const

Returns the content type provided by the user agent

Definition at line 21 of file upload.cpp.

References Upload().

◆ createTemporaryFile()

QTemporaryFile * Upload::createTemporaryFile ( const QString & templateName = QString())

This function creates a temporary file and fill it with the content of this upload. Returns zero if an error occours.

Definition at line 83 of file upload.cpp.

References Upload(), QIODevice::atEnd(), QIODevice::errorString(), QString::isEmpty(), QTemporaryFile::open(), QIODevice::read(), QFile::remove(), seek(), QFileDevice::seek(), QIODevice::setErrorString(), and QIODevice::write().

◆ filename()

QString Upload::filename ( ) const

Returns the file name provided by the user agent

Definition at line 15 of file upload.cpp.

References Upload().

◆ headers()

Headers Upload::headers ( ) const

Returns the headers provided by the user agent

Definition at line 27 of file upload.cpp.

References Upload().

◆ name()

QString Upload::name ( ) const

Returns the name of the form field

Definition at line 184 of file upload.cpp.

References Upload().

◆ pos()

qint64 Upload::pos ( ) const
overridevirtual

Reimplemented from QIODevice::pos().

Reimplemented from QIODevice.

Definition at line 131 of file upload.cpp.

References Upload().

Referenced by seek().

◆ readData()

qint64 Upload::readData ( char * data,
qint64 maxlen )
overrideprotectedvirtual

Reimplemented from QIODevice::readData().

Implements QIODevice.

Definition at line 190 of file upload.cpp.

References Upload(), and size().

◆ readLineData()

qint64 Upload::readLineData ( char * data,
qint64 maxlen )
overrideprotectedvirtual

Reimplemented from QIODevice::readLineData().

Reimplemented from QIODevice.

Definition at line 202 of file upload.cpp.

References Upload(), and size().

◆ save()

bool Upload::save ( const QString & filename)

◆ seek()

bool Upload::seek ( qint64 pos)
overridevirtual

Reimplemented from QIODevice::seek().

Reimplemented from QIODevice.

Definition at line 143 of file upload.cpp.

References Upload(), pos(), QIODevice::seek(), and size().

Referenced by createTemporaryFile(), and save().

◆ size()

qint64 Upload::size ( ) const
overridevirtual

Reimplemented from QIODevice::size().

Reimplemented from QIODevice.

Definition at line 137 of file upload.cpp.

References Upload().

Referenced by readData(), readLineData(), and seek().

◆ writeData()

qint64 Upload::writeData ( const char * data,
qint64 maxSize )
overrideprotectedvirtual

Reimplemented from QIODevice::writeData().

Implements QIODevice.

Definition at line 214 of file upload.cpp.