QHttpHeaders Class

// Values as separate header entries
myheadername: myheadervalue1
myheadername: myheadervalue2
// Combined value
myheadername: myheadervalue1, myheadervalue2

成员函数文档

[noexcept] QHttpHeaders::QHttpHeaders()

创建一个新的 QHttpHeaders 对象。

QHttpHeaders::QHttpHeaders(const QHttpHeaders &other)

创建other 的副本。

[constexpr noexcept default] QHttpHeaders::QHttpHeaders(QHttpHeaders &&other)

从 `other` 移动构造该对象，该对象将被保留为 `empty`。

[noexcept] QHttpHeaders::~QHttpHeaders()

销毁 headers 对象。

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

使用name 和value 追加一个标头条目，成功时返回true 。

另请参阅 append(QHttpHeaders::WellKnownHeader, QAnyStringView) 和Allowed field name and value characters 。

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

void QHttpHeaders::clear()

清除所有标头条目。

另请参阅 size()。

QByteArray QHttpHeaders::combinedValue(QAnyStringView name) const

返回name 标头值的逗号分隔字符串。如果该标头不存在（name ），则返回null QByteArray 。

另请参阅 values(QAnyStringView)。

QByteArray QHttpHeaders::combinedValue(QHttpHeaders::WellKnownHeader name) const

bool QHttpHeaders::contains(QAnyStringView name) const

返回头部是否包含name 的头部。

另请参阅 contains(QHttpHeaders::WellKnownHeader)。

bool QHttpHeaders::contains(QHttpHeaders::WellKnownHeader name) const

[since 6.10] std::optional<QDateTime> QHttpHeaders::dateTimeValue(QAnyStringView name) const

将name 中找到的第一个标头值转换为QDateTime 对象，遵循标准的HTTP日期格式。如果该标头不存在或包含无效的QDateTime ，则返回std::nullopt 。

该函数在 Qt 6.10 中引入。

另请参见 setDateTimeValue()、dateTimeValues(QAnyStringView name) 和dateTimeValueAt(qsizetype i)。

[since 6.10] std::optional<QDateTime> QHttpHeaders::dateTimeValue(QHttpHeaders::WellKnownHeader name) const

该函数于 Qt 6.10 中引入。

[since 6.10] std::optional<QDateTime> QHttpHeaders::dateTimeValueAt(qsizetype i) const

将索引为i 的头部值转换为符合标准HTTP日期格式的QDateTime 对象。索引i 必须有效。

该函数于 Qt 6.10 中引入。

另请参阅 dateTimeValue(QAnyStringView name) 和dateTimeValues(QAnyStringView name)。

[since 6.10] std::optional<QList<QDateTime>> QHttpHeaders::dateTimeValues(QAnyStringView name) const

返回name 的所有标头值，将其作为QDateTime 对象的列表，并遵循标准HTTP日期格式。如果未找到有效的日期时间值，则返回std::nullopt 。

该函数在 Qt 6.10 中引入。

另请参阅 dateTimeValue(QAnyStringView name) 和dateTimeValueAt(qsizetype i)。

[since 6.10] std::optional<QList<QDateTime>> QHttpHeaders::dateTimeValues(QHttpHeaders::WellKnownHeader name) const

该函数于 Qt 6.10 中引入。

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

创建一个新的QHttpHeaders 对象，并将其初始化为headers 。

另请参阅 Allowed field name and value characters 。

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

创建一个新的QHttpHeaders 对象，并将其初始化为headers 。

另请参阅 Allowed field name and value characters 。

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

创建一个新的QHttpHeaders 对象，并将其初始化为headers 。

另请参阅 Allowed field name and value characters 。

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

在索引i 处插入一个标头条目，其值为name 和value 。该索引必须有效（参见size()）。返回插入是否成功。

另请参阅 append()、insert(qsizetype, QHttpHeaders::WellKnownHeader, QAnyStringView)、size() 以及Allowed field name and value characters 。

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

[noexcept, since 6.10] std::optional<qint64> QHttpHeaders::intValue(QAnyStringView name) const

返回第一个有效标头name 的值，该值被解释为一个64位整数。如果该标头不存在或无法解析为整数，则返回std::nullopt 。

该函数在 Qt 6.10 中引入。

另请参阅 intValues(QAnyStringView name) 和intValueAt(qsizetype i)。

[noexcept, since 6.10] std::optional<qint64> QHttpHeaders::intValue(QHttpHeaders::WellKnownHeader name) const

该函数于 Qt 6.10 版本中引入。

[noexcept, since 6.10] std::optional<qint64> QHttpHeaders::intValueAt(qsizetype i) const

返回索引i 处被解释为64位整数的头值。索引i 必须有效。

该函数在 Qt 6.10 中引入。

另请参阅 intValues(QAnyStringView name) 和intValue(QAnyStringView name)。

[since 6.10] std::optional<QList<qint64>> QHttpHeaders::intValues(QAnyStringView name) const

返回将标头name 解析为64位整数后的值，并以列表形式返回。如果该标头不存在或无法解析为整数，则返回std::nullopt 。

该函数在 Qt 6.10 中引入。

另请参阅 intValue(QAnyStringView name) 和intValueAt(qsizetype i)。

[since 6.10] std::optional<QList<qint64>> QHttpHeaders::intValues(QHttpHeaders::WellKnownHeader name) const

该函数于 Qt 6.10 版本中引入。

[noexcept] bool QHttpHeaders::isEmpty() const

如果标头大小为 0，则返回true ；否则返回false 。

另请参阅 size()。

[noexcept] QLatin1StringView QHttpHeaders::nameAt(qsizetype i) const

返回索引为i 处的标头名称。索引i 必须有效（参见size()）。

标头名称不区分大小写，且返回的名称均为小写。

另请参阅 size() 和valueAt()。

[since 6.12] std::optional<QHttpHeaderRangeSet> QHttpHeaders::rangeValues() const

返回Range HTTP 头字段的范围，如果解析失败，则返回std::nullopt 。

每个范围代表一个字节范围。根据 RFC 9110：

• 如果指定了起始位置但未指定结束位置（例如，“bytes=500-”），则QHttpHeaderRangeSpec 将包含start=500 和end=std::nullopt 。
• 如果指定了结束点但未指定起始点（例如，“bytes=-500”），则QHttpHeaderRangeSpec 将包含start=std::nullopt 和end=500 ，代表最后 500 个字节。
• 如果两者都指定了（例如，“bytes=0-499”），则QHttpHeaderRangeSpec 将包含start=0 和end=499 。

这些范围将按其在标头中出现的顺序返回。

解析行为如下：

• 如果不存在Range 标头，则返回一个空范围集。
• 根据 RFC 9110 第 14.2 节，任何包含除“bytes”以外单位的Range 标头（例如“seconds=1-2”）都将被忽略。这些被忽略的标头不会导致解析失败。
• 如果Range 标头使用了“bytes”单位但格式不正确（例如缺少连字符、包含无效字符或无效数字），则该函数返回std::nullopt 。

该函数在 Qt 6.12 中引入。

另请参阅 setRangeValues 和WellKnownHeader::Range 。

void QHttpHeaders::removeAll(QAnyStringView name)

删除name 头部。

另请参阅 removeAt() 和removeAll(QHttpHeaders::WellKnownHeader)。

void QHttpHeaders::removeAll(QHttpHeaders::WellKnownHeader name)

void QHttpHeaders::removeAt(qsizetype i)

删除索引为i 的标头。索引i 必须有效（参见size()）。

另请参阅 removeAll(QHttpHeaders::WellKnownHeader)、removeAll(QAnyStringView) 以及size()。

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

将索引为i 的标头条目替换为name 和newValue 。该索引必须有效（参见size()）。返回替换是否成功。

另请参阅 append()、replace(qsizetype, QHttpHeaders::WellKnownHeader, QAnyStringView)、size() 以及Allowed field name and value characters 。

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

[since 6.8] bool QHttpHeaders::replaceOrAppend(QHttpHeaders::WellKnownHeader name, QAnyStringView newValue)

如果QHttpHeaders 已包含name ，则将其值替换为newValue ，并移除可能存在的其他name 条目。如果name 不存在，则追加一条新条目。成功时返回true 。

该函数是用于设置唯一name:newValue 头文件的便捷方法。对于大多数头文件而言，其相对顺序并不重要，因此如果已存在条目，则可以复用该条目。

该函数在 Qt 6.8 中引入。

另请参阅 replaceOrAppend(QAnyStringView, QAnyStringView)。

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

void QHttpHeaders::reserve(qsizetype size)

尝试为至少size 个头条目分配内存。

如果您事先知道将有多少个标头条目，可以调用此函数来避免重新分配和内存碎片。

[since 6.10] void QHttpHeaders::setDateTimeValue(QAnyStringView name, const QDateTime &dateTime)

将标头名称name 的值设置为dateTime ，遵循标准的HTTP IMF-fixdate格式。如果该标头不存在，则添加一个新的标头。

该函数在 Qt 6.10 中引入。

另请参阅 dateTimeValue(QAnyStringView name) 和dateTimeValueAt(qsizetype i)。

[since 6.10] void QHttpHeaders::setDateTimeValue(QHttpHeaders::WellKnownHeader name, const QDateTime &dateTime)

该函数于 Qt 6.10 中引入。

[since 6.12] void QHttpHeaders::setRangeValues(const QHttpHeaderRangeSet &ranges)

将Range HTTP头字段设置为指定的ranges 列表。

这些范围采用“字节”单位进行格式化，并按ranges 中存储的顺序排列。对于每个QHttpHeaderRangeSpec ：

• 仅包含起始点的范围（例如，QHttpHeaderRangeSpec(500, std::nullopt)）将格式化为"500-" 。
• 仅包含结束点的范围（例如，QHttpHeaderRangeSpec(std::nullopt, 500)）将格式化为"-500" ，表示最后 500 字节。
• 同时包含起始和结束的范围（例如，QHttpHeaderRangeSpec(0, 499)）将格式化为"0-499" 。

如果提供了多个范围，它们将用逗号分隔，例如："bytes=0-499, 1000-”。

如果 `ranges ` 为空，则会移除 `Range ` 头部。

该函数自 Qt 6.12 起引入。

另请参阅 rangeValues() 和WellKnownHeader::Range 。

[noexcept] qsizetype QHttpHeaders::size() const

返回标头条目的数量。

[noexcept] void QHttpHeaders::swap(QHttpHeaders &other)

将此链接QHttpHeaders 替换为other 。此操作非常快，且从未失败。

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

将标头条目作为 (名称, 值) 对的列表返回。标头名称不区分大小写，且返回的名称均为小写。

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

将标头条目作为从名称到值（或多个值）的哈希表返回。标头名称不区分大小写，且返回的名称均转换为小写。

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

将标头条目作为从名称到值（或多个值）的映射返回。标头名称不区分大小写，且返回的名称均转换为小写。

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

返回（第一个）标头name 的值；如果该标头不存在，则返回defaultValue 。

另请参见 value （QHttpHeaders::WellKnownHeader、QByteArrayView）。

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

[noexcept] QByteArrayView QHttpHeaders::valueAt(qsizetype i) const

返回索引为i 的标头值。索引i 必须有效（参见size()）。

另请参阅 size()、value()、values()、combinedValue() 以及nameAt()。

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

返回标头name 的值，并将其装入一个列表中。如果不存在name 的标头，则返回一个空列表。

另请参阅 values(QHttpHeaders::WellKnownHeader)。

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

[static noexcept] QByteArrayView QHttpHeaders::wellKnownHeaderName(QHttpHeaders::WellKnownHeader name)

返回一个与给定的name 对应的视图形式的标头名称。

[noexcept] QHttpHeaders &QHttpHeaders::operator=(QHttpHeaders &&other)

该操作将other 进行移入赋值，并返回对此对象的引用。

other empty 将被保留。

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

将other 的内容赋值给该对象，并返回对此对象的引用。