#include <qhttpheaders.h>

Collaboration diagram for QHttpHeaders:

Public Types
enum class	WellKnownHeader { AIM , Accept , AcceptAdditions , AcceptCH , AcceptDatetime , AcceptEncoding , AcceptFeatures , AcceptLanguage , AcceptPatch , AcceptPost , AcceptRanges , AcceptSignature , AccessControlAllowCredentials , AccessControlAllowHeaders , AccessControlAllowMethods , AccessControlAllowOrigin , AccessControlExposeHeaders , AccessControlMaxAge , AccessControlRequestHeaders , AccessControlRequestMethod , Age , Allow , ALPN , AltSvc , AltUsed , Alternates , ApplyToRedirectRef , AuthenticationControl , AuthenticationInfo , Authorization , CacheControl , CacheStatus , CalManagedID , CalDAVTimezones , CapsuleProtocol , CDNCacheControl , CDNLoop , CertNotAfter , CertNotBefore , ClearSiteData , ClientCert , ClientCertChain , Close , Connection , ContentDigest , ContentDisposition , ContentEncoding , ContentID , ContentLanguage , ContentLength , ContentLocation , ContentRange , ContentSecurityPolicy , ContentSecurityPolicyReportOnly , ContentType , Cookie , CrossOriginEmbedderPolicy , CrossOriginEmbedderPolicyReportOnly , CrossOriginOpenerPolicy , CrossOriginOpenerPolicyReportOnly , CrossOriginResourcePolicy , DASL , Date , DAV , DeltaBase , Depth , Destination , DifferentialID , DPoP , DPoPNonce , EarlyData , ETag , Expect , ExpectCT , Expires , Forwarded , From , Hobareg , Host , If , IfMatch , IfModifiedSince , IfNoneMatch , IfRange , IfScheduleTagMatch , IfUnmodifiedSince , IM , IncludeReferredTokenBindingID , KeepAlive , Label , LastEventID , LastModified , Link , Location , LockToken , MaxForwards , MementoDatetime , Meter , MIMEVersion , Negotiate , NEL , ODataEntityId , ODataIsolation , ODataMaxVersion , ODataVersion , OptionalWWWAuthenticate , OrderingType , Origin , OriginAgentCluster , OSCORE , OSLCCoreVersion , Overwrite , PingFrom , PingTo , Position , Prefer , PreferenceApplied , Priority , ProxyAuthenticate , ProxyAuthenticationInfo , ProxyAuthorization , ProxyStatus , PublicKeyPins , PublicKeyPinsReportOnly , Range , RedirectRef , Referer , Refresh , ReplayNonce , ReprDigest , RetryAfter , ScheduleReply , ScheduleTag , SecPurpose , SecTokenBinding , SecWebSocketAccept , SecWebSocketExtensions , SecWebSocketKey , SecWebSocketProtocol , SecWebSocketVersion , Server , ServerTiming , SetCookie , Signature , SignatureInput , SLUG , SoapAction , StatusURI , StrictTransportSecurity , Sunset , SurrogateCapability , SurrogateControl , TCN , TE , Timeout , Topic , Traceparent , Tracestate , Trailer , TransferEncoding , TTL , Upgrade , Urgency , UserAgent , VariantVary , Vary , Via , WantContentDigest , WantReprDigest , WWWAuthenticate , XContentTypeOptions , XFrameOptions , AcceptCharset , CPEPInfo , Pragma , ProtocolInfo , ProtocolQuery }
	List of well known headers as per \l {https://www.iana.org/assignments/http-fields}{IANA registry}. More...

Public Member Functions
Q_NETWORK_EXPORT	QHttpHeaders () noexcept
	Creates a new QHttpHeaders object.
Q_NETWORK_EXPORT	~QHttpHeaders ()
	Disposes of the headers object.
Q_NETWORK_EXPORT	QHttpHeaders (const QHttpHeaders &other)
	Creates a copy of other.
	QHttpHeaders (QHttpHeaders &&other) noexcept=default
	Move-constructs the object from other, which will be left \l{isEmpty()}{empty}.
Q_NETWORK_EXPORT QHttpHeaders &	operator= (const QHttpHeaders &other)
	Assigns the contents of other and returns a reference to this object.
void	swap (QHttpHeaders &other) noexcept
	\memberswap{QHttpHeaders}
Q_NETWORK_EXPORT bool	append (QAnyStringView name, QAnyStringView value)
	Appends a header entry with name and value and returns `true` if successful.
Q_NETWORK_EXPORT bool	append (WellKnownHeader name, QAnyStringView value)
Q_NETWORK_EXPORT bool	insert (qsizetype i, QAnyStringView name, QAnyStringView value)
	Inserts a header entry at index i, with name and value.
Q_NETWORK_EXPORT bool	insert (qsizetype i, WellKnownHeader name, QAnyStringView value)
Q_NETWORK_EXPORT bool	replace (qsizetype i, QAnyStringView name, QAnyStringView newValue)
	Replaces the header entry at index i, with name and newValue.
Q_NETWORK_EXPORT bool	replace (qsizetype i, WellKnownHeader name, QAnyStringView newValue)
Q_NETWORK_EXPORT bool	replaceOrAppend (QAnyStringView name, QAnyStringView newValue)
Q_NETWORK_EXPORT bool	replaceOrAppend (WellKnownHeader name, QAnyStringView newValue)
Q_NETWORK_EXPORT bool	contains (QAnyStringView name) const
	Returns whether the headers contain header with name.
Q_NETWORK_EXPORT bool	contains (WellKnownHeader name) const
Q_NETWORK_EXPORT void	clear ()
	Clears all header entries.
Q_NETWORK_EXPORT void	removeAll (QAnyStringView name)
	Removes the header name.
Q_NETWORK_EXPORT void	removeAll (WellKnownHeader name)
Q_NETWORK_EXPORT void	removeAt (qsizetype i)
	Removes the header at index i.
Q_NETWORK_EXPORT QByteArrayView	value (QAnyStringView name, QByteArrayView defaultValue={}) const noexcept
	Returns the value of the (first) header name, or defaultValue if it doesn't exist.
Q_NETWORK_EXPORT QByteArrayView	value (WellKnownHeader name, QByteArrayView defaultValue={}) const noexcept
Q_NETWORK_EXPORT QList< QByteArray >	values (QAnyStringView name) const
	Returns the values of header name in a list.
Q_NETWORK_EXPORT QList< QByteArray >	values (WellKnownHeader name) const
Q_NETWORK_EXPORT QByteArrayView	valueAt (qsizetype i) const noexcept
	Returns the header value at index i.
Q_NETWORK_EXPORT QLatin1StringView	nameAt (qsizetype i) const noexcept
	Returns the header name at index i.
Q_NETWORK_EXPORT QByteArray	combinedValue (QAnyStringView name) const
	Returns the values of header name in a comma-combined string.
Q_NETWORK_EXPORT QByteArray	combinedValue (WellKnownHeader name) const
Q_NETWORK_EXPORT std::optional< qint64 >	intValue (QAnyStringView name) const noexcept
Q_NETWORK_EXPORT std::optional< qint64 >	intValue (WellKnownHeader name) const noexcept
Q_NETWORK_EXPORT std::optional< QList< qint64 > >	intValues (QAnyStringView name) const
Q_NETWORK_EXPORT std::optional< QList< qint64 > >	intValues (WellKnownHeader name) const
Q_NETWORK_EXPORT std::optional< qint64 >	intValueAt (qsizetype i) const noexcept
Q_NETWORK_EXPORT std::optional< QDateTime >	dateTimeValue (QAnyStringView name) const
Q_NETWORK_EXPORT std::optional< QDateTime >	dateTimeValue (WellKnownHeader name) const
Q_NETWORK_EXPORT std::optional< QList< QDateTime > >	dateTimeValues (QAnyStringView name) const
Q_NETWORK_EXPORT std::optional< QList< QDateTime > >	dateTimeValues (WellKnownHeader name) const
Q_NETWORK_EXPORT std::optional< QDateTime >	dateTimeValueAt (qsizetype i) const
Q_NETWORK_EXPORT void	setDateTimeValue (QAnyStringView name, const QDateTime &dateTime)
Q_NETWORK_EXPORT void	setDateTimeValue (WellKnownHeader name, const QDateTime &dateTime)
Q_NETWORK_EXPORT std::optional< QHttpHeaderRangeSet >	rangeValues () const
Q_NETWORK_EXPORT void	setRangeValues (const QHttpHeaderRangeSet &ranges)
Q_NETWORK_EXPORT qsizetype	size () const noexcept
	Returns the number of header entries.
Q_NETWORK_EXPORT void	reserve (qsizetype size)
	Attempts to allocate memory for at least size header entries.
bool	isEmpty () const noexcept
	Returns `true` if the headers have size 0; otherwise returns `false`.
Q_NETWORK_EXPORT QList< std::pair< QByteArray, QByteArray > >	toListOfPairs () const
	Returns the header entries as a list of (name, value) pairs.
Q_NETWORK_EXPORT QMultiMap< QByteArray, QByteArray >	toMultiMap () const
	Returns the header entries as a map from name to value(s).
Q_NETWORK_EXPORT QMultiHash< QByteArray, QByteArray >	toMultiHash () const
	Returns the header entries as a hash from name to value(s).

Static Public Member Functions
static Q_NETWORK_EXPORT QByteArrayView	wellKnownHeaderName (WellKnownHeader name) noexcept
	Returns a header name corresponding to the provided name as a view.
static Q_NETWORK_EXPORT QHttpHeaders	fromListOfPairs (const QList< std::pair< QByteArray, QByteArray > > &headers)
	Creates a new QHttpHeaders object that is populated with headers.
static Q_NETWORK_EXPORT QHttpHeaders	fromMultiMap (const QMultiMap< QByteArray, QByteArray > &headers)
	Creates a new QHttpHeaders object that is populated with headers.
static Q_NETWORK_EXPORT QHttpHeaders	fromMultiHash (const QMultiHash< QByteArray, QByteArray > &headers)
	Creates a new QHttpHeaders object that is populated with headers.

Friends
Q_NETWORK_EXPORT QDebug	operator<< (QDebug debug, const QHttpHeaders &headers)
	Writes headers into debug stream.
Q_NETWORK_EXPORT QDataStream &	operator<< (QDataStream &stream, const QHttpHeaders &headers)
Q_NETWORK_EXPORT QDataStream &	operator>> (QDataStream &stream, QHttpHeaders &headers)

Related Symbols
(Note that these are not member symbols.)
	intValues
	setDateTimeValue
	dateTimeValues
	intValues
	setDateTimeValue
	dateTimeValues

Detailed Description

Definition at line 110 of file qhttpheaders.h.

Member Enumeration Documentation

◆ WellKnownHeader

enum class QHttpHeaders::WellKnownHeader

strong

List of well known headers as per \l {https://www.iana.org/assignments/http-fields}{IANA registry}.

\value AIM \value Accept \value AcceptAdditions \value AcceptCH \value AcceptDatetime \value AcceptEncoding \value AcceptFeatures \value AcceptLanguage \value AcceptPatch \value AcceptPost \value AcceptRanges \value AcceptSignature \value AccessControlAllowCredentials \value AccessControlAllowHeaders \value AccessControlAllowMethods \value AccessControlAllowOrigin \value AccessControlExposeHeaders \value AccessControlMaxAge \value AccessControlRequestHeaders \value AccessControlRequestMethod \value Age \value Allow \value ALPN \value AltSvc \value AltUsed \value Alternates \value ApplyToRedirectRef \value AuthenticationControl \value AuthenticationInfo \value Authorization \value CacheControl \value CacheStatus \value CalManagedID \value CalDAVTimezones \value CapsuleProtocol \value CDNCacheControl \value CDNLoop \value CertNotAfter \value CertNotBefore \value ClearSiteData \value ClientCert \value ClientCertChain \value Close \value Connection \value ContentDigest \value ContentDisposition \value ContentEncoding \value ContentID \value ContentLanguage \value ContentLength \value ContentLocation \value ContentRange \value ContentSecurityPolicy \value ContentSecurityPolicyReportOnly \value ContentType \value Cookie \value CrossOriginEmbedderPolicy \value CrossOriginEmbedderPolicyReportOnly \value CrossOriginOpenerPolicy \value CrossOriginOpenerPolicyReportOnly \value CrossOriginResourcePolicy \value DASL \value Date \value DAV \value DeltaBase \value Depth \value Destination \value DifferentialID \value DPoP \value DPoPNonce \value EarlyData \value ETag \value Expect \value ExpectCT \value Expires \value Forwarded \value From \value Hobareg \value Host \value If \value IfMatch \value IfModifiedSince \value IfNoneMatch \value IfRange \value IfScheduleTagMatch \value IfUnmodifiedSince \value IM \value IncludeReferredTokenBindingID \value KeepAlive \value Label \value LastEventID \value LastModified \value Link \value Location \value LockToken \value MaxForwards \value MementoDatetime \value Meter \value MIMEVersion \value Negotiate \value NEL \value ODataEntityId \value ODataIsolation \value ODataMaxVersion \value ODataVersion \value OptionalWWWAuthenticate \value OrderingType \value Origin \value OriginAgentCluster \value OSCORE \value OSLCCoreVersion \value Overwrite \value PingFrom \value PingTo \value Position \value Prefer \value PreferenceApplied \value Priority \value ProxyAuthenticate \value ProxyAuthenticationInfo \value ProxyAuthorization \value ProxyStatus \value PublicKeyPins \value PublicKeyPinsReportOnly \value Range \value RedirectRef \value Referer \value Refresh \value ReplayNonce \value ReprDigest \value RetryAfter \value ScheduleReply \value ScheduleTag \value SecPurpose \value SecTokenBinding \value SecWebSocketAccept \value SecWebSocketExtensions \value SecWebSocketKey \value SecWebSocketProtocol \value SecWebSocketVersion \value Server \value ServerTiming \value SetCookie \value Signature \value SignatureInput \value SLUG \value SoapAction \value StatusURI \value StrictTransportSecurity \value Sunset \value SurrogateCapability \value SurrogateControl \value TCN \value TE \value Timeout \value Topic \value Traceparent \value Tracestate \value Trailer \value TransferEncoding \value TTL \value Upgrade \value Urgency \value UserAgent \value VariantVary \value Vary \value Via \value WantContentDigest \value WantReprDigest \value WWWAuthenticate \value XContentTypeOptions \value XFrameOptions \value AcceptCharset \value CPEPInfo \value Pragma \value ProtocolInfo \value ProtocolQuery

Enumerator
AIM
Accept
AcceptAdditions
AcceptCH
AcceptDatetime
AcceptEncoding
AcceptFeatures
AcceptLanguage
AcceptPatch
AcceptPost
AcceptRanges
AcceptSignature
AccessControlAllowCredentials
AccessControlAllowHeaders
AccessControlAllowMethods
AccessControlAllowOrigin
AccessControlExposeHeaders
AccessControlMaxAge
AccessControlRequestHeaders
AccessControlRequestMethod
Age
Allow
ALPN
AltSvc
AltUsed
Alternates
ApplyToRedirectRef
AuthenticationControl
AuthenticationInfo
Authorization
CacheControl
CacheStatus
CalManagedID
CalDAVTimezones
CapsuleProtocol
CDNCacheControl
CDNLoop
CertNotAfter
CertNotBefore
ClearSiteData
ClientCert
ClientCertChain
Close
Connection
ContentDigest
ContentDisposition
ContentEncoding
ContentID
ContentLanguage
ContentLength
ContentLocation
ContentRange
ContentSecurityPolicy
ContentSecurityPolicyReportOnly
ContentType
Cookie
CrossOriginEmbedderPolicy
CrossOriginEmbedderPolicyReportOnly
CrossOriginOpenerPolicy
CrossOriginOpenerPolicyReportOnly
CrossOriginResourcePolicy
DASL
Date
DAV
DeltaBase
Depth
Destination
DifferentialID
DPoP
DPoPNonce
EarlyData
ETag
Expect
ExpectCT
Expires
Forwarded
From
Hobareg
Host
If
IfMatch
IfModifiedSince
IfNoneMatch
IfRange
IfScheduleTagMatch
IfUnmodifiedSince
IM
IncludeReferredTokenBindingID
KeepAlive
Label
LastEventID
LastModified
Link
Location
LockToken
MaxForwards
MementoDatetime
Meter
MIMEVersion
Negotiate
NEL
ODataEntityId
ODataIsolation
ODataMaxVersion
ODataVersion
OptionalWWWAuthenticate
OrderingType
Origin
OriginAgentCluster
OSCORE
OSLCCoreVersion
Overwrite
PingFrom
PingTo
Position
Prefer
PreferenceApplied
Priority
ProxyAuthenticate
ProxyAuthenticationInfo
ProxyAuthorization
ProxyStatus
PublicKeyPins
PublicKeyPinsReportOnly
Range
RedirectRef
Referer
Refresh
ReplayNonce
ReprDigest
RetryAfter
ScheduleReply
ScheduleTag
SecPurpose
SecTokenBinding
SecWebSocketAccept
SecWebSocketExtensions
SecWebSocketKey
SecWebSocketProtocol
SecWebSocketVersion
Server
ServerTiming
SetCookie
Signature
SignatureInput
SLUG
SoapAction
StatusURI
StrictTransportSecurity
Sunset
SurrogateCapability
SurrogateControl
TCN
TE
Timeout
Topic
Traceparent
Tracestate
Trailer
TransferEncoding
TTL
Upgrade
Urgency
UserAgent
VariantVary
Vary
Via
WantContentDigest
WantReprDigest
WWWAuthenticate
XContentTypeOptions
XFrameOptions
AcceptCharset
CPEPInfo
Pragma
ProtocolInfo
ProtocolQuery

Definition at line 114 of file qhttpheaders.h.

Constructor & Destructor Documentation

◆ QHttpHeaders() [1/3]

QHttpHeaders::QHttpHeaders ( )

noexcept

Creates a new QHttpHeaders object.

Definition at line 1280 of file qhttpheaders.cpp.

◆ ~QHttpHeaders()

QHttpHeaders::~QHttpHeaders ( )

default

Disposes of the headers object.

◆ QHttpHeaders() [2/3]

QHttpHeaders::QHttpHeaders ( const QHttpHeaders & other )

default

Creates a copy of other.

◆ QHttpHeaders() [3/3]

QHttpHeaders::QHttpHeaders ( QHttpHeaders && other )

defaultnoexcept

Move-constructs the object from other, which will be left \l{isEmpty()}{empty}.

Member Function Documentation

◆ append() [1/2]

bool QHttpHeaders::append	(	QAnyStringView	name,
		QAnyStringView	value )

Appends a header entry with name and value and returns true if successful.

See also: append(QHttpHeaders::WellKnownHeader, QAnyStringView); {Allowed field name and value characters}

Definition at line 1541 of file qhttpheaders.cpp.

◆ append() [2/2]

bool QHttpHeaders::append	(	WellKnownHeader	name,
		QAnyStringView	value )

Definition at line 1554 of file qhttpheaders.cpp.

◆ clear()

void QHttpHeaders::clear ( )

Clears all header entries.

See also: size()

Definition at line 2255 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ combinedValue() [1/2]

QByteArray QHttpHeaders::combinedValue ( QAnyStringView name ) const

Returns the values of header name in a comma-combined string.

Returns a null QByteArray if the header with name doesn't exist.

Note: Accessing the value(s) of 'Set-Cookie' header this way may not work as intended. It is a notable exception in the \l {https://datatracker.ietf.org/doc/html/rfc9110#name-field-order}{HTTP RFC} in that its values cannot be combined this way. Prefer \l values() instead.

See also: values(QAnyStringView)

Definition at line 1827 of file qhttpheaders.cpp.

◆ combinedValue() [2/2]

QByteArray QHttpHeaders::combinedValue ( WellKnownHeader name ) const

Definition at line 1840 of file qhttpheaders.cpp.

◆ contains() [1/2]

bool QHttpHeaders::contains ( QAnyStringView name ) const

Returns whether the headers contain header with name.

See also: contains(QHttpHeaders::WellKnownHeader)

Definition at line 1677 of file qhttpheaders.cpp.

References headerNameMatches(), and isEmpty().

Here is the call graph for this function:

◆ contains() [2/2]

bool QHttpHeaders::contains ( WellKnownHeader name ) const

Definition at line 1688 of file qhttpheaders.cpp.

References headerNameMatches(), and isEmpty().

Here is the call graph for this function:

◆ dateTimeValue() [1/2]

std::optional< QDateTime > QHttpHeaders::dateTimeValue ( QAnyStringView name ) const

Since: 6.10

Converts the first found header value of name to a QDateTime object, following the standard HTTP date formats. If the header does not exist or contains an invalid QDateTime, returns \nullopt.

See also: dateTimeValues(QAnyStringView name), dateTimeValueAt(qsizetype i)

Definition at line 1941 of file qhttpheaders.cpp.

◆ dateTimeValue() [2/2]

std::optional< QDateTime > QHttpHeaders::dateTimeValue ( WellKnownHeader name ) const

Definition at line 1956 of file qhttpheaders.cpp.

◆ dateTimeValueAt()

std::optional< QDateTime > QHttpHeaders::dateTimeValueAt ( qsizetype i ) const

Since: 6.10

Converts the header value at index i to a QDateTime object following the standard HTTP date formats. The index i must be valid.

See also: dateTimeValue(QAnyStringView name), dateTimeValues(QAnyStringView name)

Definition at line 2027 of file qhttpheaders.cpp.

◆ dateTimeValues() [1/2]

std::optional< QList< QDateTime > > QHttpHeaders::dateTimeValues ( QAnyStringView name ) const

Since: 6.10

Returns all the header values of name in a list of QDateTime objects, following the standard HTTP date formats. If no valid date-time values are found, returns \nullopt.

See also: dateTimeValue(QAnyStringView name), dateTimeValueAt(qsizetype i)

Definition at line 1998 of file qhttpheaders.cpp.

◆ dateTimeValues() [2/2]

std::optional< QList< QDateTime > > QHttpHeaders::dateTimeValues ( WellKnownHeader name ) const

Definition at line 2014 of file qhttpheaders.cpp.

◆ fromListOfPairs()

QHttpHeaders QHttpHeaders::fromListOfPairs ( const QList< std::pair< QByteArray, QByteArray > > & headers )

static

Creates a new QHttpHeaders object that is populated with headers.

See also: {Allowed field name and value characters}

Definition at line 1290 of file qhttpheaders.cpp.

◆ fromMultiHash()

QHttpHeaders QHttpHeaders::fromMultiHash ( const QMultiHash< QByteArray, QByteArray > & headers )

static

Creates a new QHttpHeaders object that is populated with headers.

See also: {Allowed field name and value characters}

Definition at line 1320 of file qhttpheaders.cpp.

◆ fromMultiMap()

QHttpHeaders QHttpHeaders::fromMultiMap ( const QMultiMap< QByteArray, QByteArray > & headers )

static

Creates a new QHttpHeaders object that is populated with headers.

See also: {Allowed field name and value characters}

Definition at line 1305 of file qhttpheaders.cpp.

◆ insert() [1/2]

bool QHttpHeaders::insert	(	qsizetype	i,
		QAnyStringView	name,
		QAnyStringView	value )

Inserts a header entry at index i, with name and value.

The index must be valid (see \l size()). Returns whether the insert succeeded.

See also: append(), insert(qsizetype, QHttpHeaders::WellKnownHeader, QAnyStringView), size(); {Allowed field name and value characters}

Definition at line 1572 of file qhttpheaders.cpp.

◆ insert() [2/2]

bool QHttpHeaders::insert	(	qsizetype	i,
		WellKnownHeader	name,
		QAnyStringView	value )

Definition at line 1586 of file qhttpheaders.cpp.

◆ intValue() [1/2]

std::optional< qint64 > QHttpHeaders::intValue ( QAnyStringView name ) const

noexcept

Since: 6.10

Returns the value of the first valid header name interpreted as a 64-bit integer. If the header does not exist or cannot be parsed as an integer, returns \nullopt.

See also: intValues(QAnyStringView name), intValueAt(qsizetype i)

Definition at line 1860 of file qhttpheaders.cpp.

◆ intValue() [2/2]

std::optional< qint64 > QHttpHeaders::intValue ( WellKnownHeader name ) const

noexcept

Definition at line 1876 of file qhttpheaders.cpp.

◆ intValueAt()

std::optional< qint64 > QHttpHeaders::intValueAt ( qsizetype i ) const

noexcept

Since: 6.10

Returns the header value interpreted as 64-bit integer at index i. The index i must be valid.

See also: intValues(QAnyStringView name), intValue(QAnyStringView name)

Definition at line 1920 of file qhttpheaders.cpp.

◆ intValues() [1/2]

std::optional< QList< qint64 > > QHttpHeaders::intValues ( QAnyStringView name ) const

Since: 6.10

Returns the values of the header name interpreted as 64-bit integer in a list. If the header does not exist or cannot be parsed as an integer, returns \nullopt.

See also: intValue(QAnyStringView name), intValueAt(qsizetype i)

Definition at line 1890 of file qhttpheaders.cpp.

◆ intValues() [2/2]

std::optional< QList< qint64 > > QHttpHeaders::intValues ( WellKnownHeader name ) const

Definition at line 1907 of file qhttpheaders.cpp.

◆ isEmpty()

bool QHttpHeaders::isEmpty ( ) const

inlinenoexcept

Returns true if the headers have size 0; otherwise returns false.

See also: size()

Definition at line 362 of file qhttpheaders.h.

Referenced by clear(), contains(), contains(), removeAll(), removeAll(), toListOfPairs(), toMultiHash(), toMultiMap(), value(), value(), values(), and values().

Here is the caller graph for this function:

◆ nameAt()

QLatin1StringView QHttpHeaders::nameAt ( qsizetype i ) const

noexcept

Returns the header name at index i.

The index i must be valid (see \l size()).

Header names are case-insensitive, and the returned names are in canonical form for known headers, and return as-is for others.

See also: size(), valueAt()

Definition at line 1809 of file qhttpheaders.cpp.

◆ operator=()

QHttpHeaders & QHttpHeaders::operator= ( const QHttpHeaders & other )

default

Assigns the contents of other and returns a reference to this object.

Move-assigns other and returns a reference to this object.

other will be left \l{isEmpty()}{empty}.

◆ rangeValues()

std::optional< QHttpHeaderRangeSet > QHttpHeaders::rangeValues ( ) const

Since: 6.12

Returns the ranges of the Range HTTP header fields, or \nullopt if parsing failed.

Each range represents a byte range. According to RFC 9110: \list

If the start is specified but the end is not (e.g., "bytes=500-"), the QHttpHeaderRangeSpec will have {start=500} and {end=std::nullopt}.
If the end is specified but the start is not (e.g., "bytes=-500"), the QHttpHeaderRangeSpec will have {start=std::nullopt} and {end=500}, representing the last 500 bytes.
If both are specified (e.g., "bytes=0-499"), the QHttpHeaderRangeSpec will have {start=0} and {end=499}. \endlist

The ranges are returned in the order in which they appear in the headers.

Parsing behaves as follows: \list

If no Range header is present, an empty range set is returned.
According to RFC 9110 Section 14.2, any Range header containing a unit other than "bytes" (e.g., "seconds=1-2") is ignored. These ignored headers do not cause the parsing to fail.
If a Range header uses the "bytes" unit but is malformed (e.g., missing the hyphen, containing invalid characters, or invalid numbers), the function returns \nullopt. \endlist

See also: setRangeValues, WellKnownHeader::Range

Definition at line 2067 of file qhttpheaders.cpp.

◆ removeAll() [1/2]

void QHttpHeaders::removeAll ( QAnyStringView name )

Removes the header name.

See also: removeAt(), removeAll(QHttpHeaders::WellKnownHeader)

Definition at line 1701 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ removeAll() [2/2]

void QHttpHeaders::removeAll ( WellKnownHeader name )

Definition at line 1712 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ removeAt()

void QHttpHeaders::removeAt ( qsizetype i )

Removes the header at index i.

The index i must be valid (see \l size()).

See also: removeAll(QHttpHeaders::WellKnownHeader), removeAll(QAnyStringView), size()

Definition at line 1727 of file qhttpheaders.cpp.

◆ replace() [1/2]

bool QHttpHeaders::replace	(	qsizetype	i,
		QAnyStringView	name,
		QAnyStringView	newValue )

Replaces the header entry at index i, with name and newValue.

The index must be valid (see \l size()). Returns whether the replace succeeded.

See also: append(), replace(qsizetype, QHttpHeaders::WellKnownHeader, QAnyStringView), size(); {Allowed field name and value characters}

Definition at line 1606 of file qhttpheaders.cpp.

◆ replace() [2/2]

bool QHttpHeaders::replace	(	qsizetype	i,
		WellKnownHeader	name,
		QAnyStringView	newValue )

Definition at line 1620 of file qhttpheaders.cpp.

◆ replaceOrAppend() [1/2]

bool QHttpHeaders::replaceOrAppend	(	QAnyStringView	name,
		QAnyStringView	newValue )

Definition at line 1660 of file qhttpheaders.cpp.

◆ replaceOrAppend() [2/2]

bool QHttpHeaders::replaceOrAppend	(	WellKnownHeader	name,
		QAnyStringView	newValue )

Since: 6.8

If QHttpHeaders already contains name, replaces its value with newValue and removes possible additional name entries. If name didn't exist, appends a new entry. Returns true if successful.

This function is a convenience method for setting a unique name : newValue header. For most headers the relative order does not matter, which allows reusing an existing entry if one exists.

See also: replaceOrAppend(QAnyStringView, QAnyStringView)

Definition at line 1645 of file qhttpheaders.cpp.

◆ reserve()

void QHttpHeaders::reserve ( qsizetype size )

Attempts to allocate memory for at least size header entries.

If you know in advance how how many header entries there will be, you may call this function to prevent reallocations and memory fragmentation.

Definition at line 2184 of file qhttpheaders.cpp.

◆ setDateTimeValue() [1/2]

void QHttpHeaders::setDateTimeValue	(	QAnyStringView	name,
		const QDateTime &	dateTime )

Since: 6.10

Sets the value of the header name name to dateTime, following the \l {https://datatracker.ietf.org/doc/html/rfc9110#name-date-time-formats}{standard HTTP IMF-fixdate format}. If the header does not exist, adds a new one.

See also: dateTimeValue(QAnyStringView name), dateTimeValueAt(qsizetype i)

Definition at line 1971 of file qhttpheaders.cpp.

◆ setDateTimeValue() [2/2]

void QHttpHeaders::setDateTimeValue	(	WellKnownHeader	name,
		const QDateTime &	dateTime )

Definition at line 1984 of file qhttpheaders.cpp.

◆ setRangeValues()

void QHttpHeaders::setRangeValues ( const QHttpHeaderRangeSet & ranges )

Since: 6.12

Sets the Range HTTP header field to the specified list of ranges.

The ranges are formatted using the "bytes" unit, in the order in which ranges holds them. For each QHttpHeaderRangeSpec: \list

A range with only a start (e.g., QHttpHeaderRangeSpec(500, std::nullopt)) is formatted as "500-".
A range with only an end (e.g., QHttpHeaderRangeSpec(std::nullopt, 500)) is formatted as "-500", representing the last 500 bytes.
A range with both start and end (e.g., QHttpHeaderRangeSpec(0, 499)) is formatted as "0-499". \endlist

If multiple ranges are provided, they will be joined by commas, for example: "bytes=0-499, 1000-".

If ranges is empty, the Range header is removed.

See also: rangeValues(), WellKnownHeader::Range

Definition at line 2142 of file qhttpheaders.cpp.

◆ size()

qsizetype QHttpHeaders::size ( ) const

noexcept

Returns the number of header entries.

Definition at line 2170 of file qhttpheaders.cpp.

◆ swap()

void QHttpHeaders::swap ( QHttpHeaders & other )

inlinenoexcept

\memberswap{QHttpHeaders}

Definition at line 304 of file qhttpheaders.h.

◆ toListOfPairs()

QList< std::pair< QByteArray, QByteArray > > QHttpHeaders::toListOfPairs ( ) const

Returns the header entries as a list of (name, value) pairs.

Header names are case-insensitive, and the returned names are lower-cased.

Definition at line 2210 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ toMultiHash()

QMultiHash< QByteArray, QByteArray > QHttpHeaders::toMultiHash ( ) const

Returns the header entries as a hash from name to value(s).

Header names are case-insensitive, and the returned names are lower-cased.

Definition at line 2239 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ toMultiMap()

QMultiMap< QByteArray, QByteArray > QHttpHeaders::toMultiMap ( ) const

Returns the header entries as a map from name to value(s).

Header names are case-insensitive, and the returned names are lower-cased.

Definition at line 2225 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ value() [1/2]

QByteArrayView QHttpHeaders::value	(	QAnyStringView	name,
		QByteArrayView	defaultValue = {} ) const

noexcept

Returns the value of the (first) header name, or defaultValue if it doesn't exist.

See also: value(QHttpHeaders::WellKnownHeader, QByteArrayView)

Definition at line 1740 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ value() [2/2]

QByteArrayView QHttpHeaders::value	(	WellKnownHeader	name,
		QByteArrayView	defaultValue = {} ) const

noexcept

Definition at line 1751 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ valueAt()

QByteArrayView QHttpHeaders::valueAt ( qsizetype i ) const

noexcept

Returns the header value at index i.

The index i must be valid (see \l size()).

See also: size(), value(), values(), combinedValue(), nameAt()

Definition at line 1794 of file qhttpheaders.cpp.

◆ values() [1/2]

QList< QByteArray > QHttpHeaders::values ( QAnyStringView name ) const

Returns the values of header name in a list.

Returns an empty list if header with name doesn't exist.

See also: values(QHttpHeaders::WellKnownHeader)

Definition at line 1765 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ values() [2/2]

QList< QByteArray > QHttpHeaders::values ( WellKnownHeader name ) const

Definition at line 1778 of file qhttpheaders.cpp.

References isEmpty().

Here is the call graph for this function:

◆ wellKnownHeaderName()

QByteArrayView QHttpHeaders::wellKnownHeaderName ( WellKnownHeader name )

staticnoexcept

Returns a header name corresponding to the provided name as a view.

Definition at line 2201 of file qhttpheaders.cpp.

◆ dateTimeValues() [1/2]

dateTimeValues ( QAnyStringView )

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

Since: 6.10

◆ dateTimeValues() [2/2]

dateTimeValues ( QAnyStringView )

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

Since: 6.10

◆ intValues() [1/2]

intValues ( QAnyStringView )

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

Since: 6.10

◆ intValues() [2/2]

intValues ( QAnyStringView )

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

Since: 6.10

◆ operator<< [1/2]

Q_NETWORK_EXPORT QDataStream & operator<<	(	QDataStream &	out,
		const QHttpHeaders &	headers )

friend

Since: 6.12

Writes headers to the out stream.

See also: {Serializing Qt Data Types}

Definition at line 1402 of file qhttpheaders.cpp.

◆ operator<< [2/2]

Q_NETWORK_EXPORT QDebug operator<<	(	QDebug	debug,
		const QHttpHeaders &	headers )

friend

Writes headers into debug stream.

Definition at line 1374 of file qhttpheaders.cpp.

◆ operator>>

Q_NETWORK_EXPORT QDataStream & operator>>	(	QDataStream &	in,
		QHttpHeaders &	headers )

friend

Since: 6.12

Reads headers from stream in into headers.

See also: {Serializing Qt Data Types}

Definition at line 1418 of file qhttpheaders.cpp.

◆ setDateTimeValue() [1/2]

setDateTimeValue ( QAnyStringView )

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

Since: 6.10

◆ setDateTimeValue() [2/2]

setDateTimeValue ( QAnyStringView )

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

Since: 6.10

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

qtbase/src/network/access/qhttpheaders.h (8519ccd2420108adeb43d99d39584b0b6813e17a)
qtbase/src/network/access/qhttpheaders.cpp (466495fdf1524edc9607c9efd1a0fcf4cd8a2665)

Public Types

Public Member Functions

Static Public Member Functions

Friends

Related Symbols

Detailed Description

Member Enumeration Documentation

◆ WellKnownHeader

Constructor & Destructor Documentation

◆ QHttpHeaders() [1/3]

◆ ~QHttpHeaders()

◆ QHttpHeaders() [2/3]

◆ QHttpHeaders() [3/3]

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ clear()

◆ combinedValue() [1/2]

◆ combinedValue() [2/2]

◆ contains() [1/2]

◆ contains() [2/2]

◆ dateTimeValue() [1/2]

◆ dateTimeValue() [2/2]

◆ dateTimeValueAt()

◆ dateTimeValues() [1/2]

◆ dateTimeValues() [2/2]

◆ fromListOfPairs()

◆ fromMultiHash()

◆ fromMultiMap()

◆ insert() [1/2]

◆ insert() [2/2]

◆ intValue() [1/2]

◆ intValue() [2/2]

◆ intValueAt()

◆ intValues() [1/2]

◆ intValues() [2/2]

◆ isEmpty()

◆ nameAt()

◆ operator=()

◆ rangeValues()

◆ removeAll() [1/2]

◆ removeAll() [2/2]

◆ removeAt()

◆ replace() [1/2]

◆ replace() [2/2]

◆ replaceOrAppend() [1/2]

◆ replaceOrAppend() [2/2]

◆ reserve()

◆ setDateTimeValue() [1/2]

◆ setDateTimeValue() [2/2]

◆ setRangeValues()

◆ size()

◆ swap()

◆ toListOfPairs()

◆ toMultiHash()

◆ toMultiMap()

◆ value() [1/2]

◆ value() [2/2]

◆ valueAt()

◆ values() [1/2]

◆ values() [2/2]

◆ wellKnownHeaderName()

Friends And Related Symbol Documentation

◆ dateTimeValues() [1/2]

◆ dateTimeValues() [2/2]

◆ intValues() [1/2]

◆ intValues() [2/2]

◆ operator<< [1/2]

◆ operator<< [2/2]

◆ operator>>

◆ setDateTimeValue() [1/2]

◆ setDateTimeValue() [2/2]