Document QHttpHeaders::WellKnownHeaders as the recommended overloads

... from a performance point of view.

Task-number: QTBUG-122020
Change-Id: I8a1558a46e74d740e330ad483454267f9922a5d5
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
(cherry picked from commit 9e26a8c0826f0914581c3e6f8e7970aed231c8e1)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Juha Vuolle 2024-02-20 11:07:17 +02:00 committed by Qt Cherry-pick Bot
parent f413e71984
commit b3c98388a4

View File

@ -70,6 +70,13 @@ Q_LOGGING_CATEGORY(lcQHttpHeaders, "qt.network.http.headers");
\l {https://datatracker.ietf.org/doc/html/rfc9110#name-field-order} \l {https://datatracker.ietf.org/doc/html/rfc9110#name-field-order}
{Set-Cookie}. Due to this and the possibility of custom use cases, {Set-Cookie}. Due to this and the possibility of custom use cases,
QHttpHeaders does not automatically combine the values. QHttpHeaders does not automatically combine the values.
\section1 Performance
Most QHttpHeaders functions provide both
\l QHttpHeaders::WellKnownHeader and \l QAnyStringView overloads.
From a memory-usage and computation point of view it is recommended
to use the \l QHttpHeaders::WellKnownHeader overloads.
*/ */
// This list is from IANA HTTP Field Name Registry // This list is from IANA HTTP Field Name Registry