The QFormDataBuilder class is a convenience class to simplify the construction of QHttpMultiPart objects. More...

#include <qformdatabuilder.h>

Collaboration diagram for QFormDataBuilder:

Public Member Functions
Q_NETWORK_EXPORT	QFormDataBuilder ()
	Constructs an empty QFormDataBuilder object.

	QFormDataBuilder (QFormDataBuilder &&other) noexcept
	Move-constructs a QFormDataBuilder instance, making it point at the same object that other was pointing to.

void	swap (QFormDataBuilder &other) noexcept

Q_NETWORK_EXPORT	~QFormDataBuilder ()
	Destroys the QFormDataBuilder object.

Q_NETWORK_EXPORT QFormDataPartBuilder &	part (QAnyStringView name)
	Constructs and returns a reference to a QFormDataPartBuilder object and sets name as the name parameter of the form-data.

Q_NETWORK_EXPORT std::unique_ptr< QHttpMultiPart >	buildMultiPart ()
	Constructs and returns a pointer to a QHttpMultipart object.

Detailed Description

The QFormDataBuilder class is a convenience class to simplify the construction of QHttpMultiPart objects.

Since: 6.8

\inmodule QtNetwork

The QFormDataBuilder class can be used to build a QHttpMultiPart object with the content type set to be FormDataType by default.

The snippet below demonstrates how to build a multipart message with QFormDataBuilder:

QFormDataBuilder builder;
QFile image(u"../../pic.png"_s); image.open(QFile::ReadOnly);
QFile mask(u"../../mask.png"_s); mask.open(QFile::ReadOnly);
 
builder.part("image"_L1).setBodyDevice(&image, "the actual image");
builder.part("mask"_L1).setBodyDevice(&mask, "the mask image");
builder.part("prompt"_L1).setBody("Lobster wearing a beret");
builder.part("n"_L1).setBody("2");
builder.part("size"_L1).setBody("512x512");
 
std::unique_ptr<QHttpMultiPart> mp = builder.buildMultiPart();

See also: QHttpPart, QHttpMultiPart, QFormDataPartBuilder

Definition at line 90 of file qformdatabuilder.h.

Constructor & Destructor Documentation

◆ QFormDataBuilder() [1/2]

QFormDataBuilder::QFormDataBuilder ( )

Constructs an empty QFormDataBuilder object.

Definition at line 302 of file qformdatabuilder.cpp.

◆ QFormDataBuilder() [2/2]

QFormDataBuilder::QFormDataBuilder ( QFormDataBuilder && other )

inlinenoexcept

Move-constructs a QFormDataBuilder instance, making it point at the same object that other was pointing to.

Definition at line 95 of file qformdatabuilder.h.

◆ ~QFormDataBuilder()

QFormDataBuilder::~QFormDataBuilder ( )

Destroys the QFormDataBuilder object.

Definition at line 312 of file qformdatabuilder.cpp.

Member Function Documentation

◆ buildMultiPart()

std::unique_ptr< QHttpMultiPart > QFormDataBuilder::buildMultiPart ( )

Constructs and returns a pointer to a QHttpMultipart object.

See also: QHttpMultiPart

Definition at line 355 of file qformdatabuilder.cpp.

References QHttpMultiPart::append(), d, QHttpMultiPart::FormDataType, multiPart, and part().

Here is the call graph for this function:

◆ part()

QFormDataPartBuilder & QFormDataBuilder::part ( QAnyStringView name )

Constructs and returns a reference to a QFormDataPartBuilder object and sets name as the name parameter of the form-data.

The returned reference is valid until the next call to this function.

Limiting name characters to US-ASCII is \l {https://datatracker.ietf.org/doc/html/rfc7578#section-5.1.1}{strongly recommended} for interoperability reasons.