QSpan 类

template <typename T, std::size_t E = std::size_t(-1)> class QSpan

基于连续数据的非拥有容器。 更多...

头: #include <QSpan>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
Since: Qt 6.7

注意: 此类的所有函数 可重入 .

公共类型

const_iterator
const_pointer
const_reference
const_reverse_iterator
difference_type
element_type
iterator
pointer
reference
reverse_iterator
size_type
value_type

公共函数

QSpan (It first , qsizetype count )
QSpan (It first , It last )
QSpan (q20::type_identity_t<T> (&)[N] arr )
QSpan (std::array<S, N> & arr )
QSpan (const std::array<S, N> & arr )
QSpan (Range && r )
QSpan (QSpan<S, N> other )
QSpan (std::span<S, N> other )
QSpan (std::initializer_list<QSpan<T, E>::value_type> il )
QSpan ()
QSpan (const QSpan<T, E> & other )
QSpan (QSpan<T, E> && other )
~QSpan ()
QSpan<T, E>::reference back () const
QSpan<T, E>::iterator begin () const
QSpan<T, E>::const_iterator cbegin () const
QSpan<T, E>::const_iterator cend () const
QSpan<T, E>::const_reverse_iterator crbegin () const
QSpan<T, E>::const_reverse_iterator crend () const
QSpan<T, E>::pointer data () const
bool empty () const
QSpan<T, E>::iterator end () const
QSpan<T, Count> first () const
QSpan<T> first (QSpan<T, E>::size_type n ) const
QSpan<T, E>::reference front () const
bool isEmpty () const
QSpan<T, Count> last () const
QSpan<T> last (QSpan<T, E>::size_type n ) const
QSpan<T, E>::reverse_iterator rbegin () const
QSpan<T, E>::reverse_iterator rend () const
QSpan<T, E>::size_type size () const
QSpan<T, E>::size_type size_bytes () const
QSpan<T> sliced (QSpan<T, E>::size_type pos ) const
QSpan<T> sliced (QSpan<T, E>::size_type pos , QSpan<T, E>::size_type n ) const
auto subspan () const
auto subspan () const
QSpan<T> subspan (QSpan<T, E>::size_type pos ) const
QSpan<T> subspan (QSpan<T, E>::size_type pos , QSpan<T, E>::size_type n ) const
QSpan<T, E> & operator= (const QSpan<T, E> & other )
QSpan<T, E> & operator= (QSpan<T, E> && other )
QSpan<T, E>::reference operator[] (QSpan<T, E>::size_type idx ) const

静态公共成员

const std::size_t extent

详细描述

QSpan 引用另一连续容器的连续部分。它充当所有种类连续容器的接口类型,不需要构造拥有容器,譬如 QList 或 std::vector 优先。

由 QSpan 引用的数据可以表示成数组 (或兼容数组的数据结构,譬如 QList , std::vector, QVarLengthArray ,等)。QSpan 本身仅仅存储数据指针,因此用户必须确保 QSpan 对象不会比它们引用的数据更长寿。

不像视图,譬如 QStringView , QLatin1StringView and QUtf8StringView , referenced data can be modified through a QSpan object. To prevent this, construct a QSpan over a const T :

int numbers[] = {0, 1, 2};
QSpan<int> span = numbers;
span[0] = 42;
// numbers == {42, 1, 2};
QSpan<const int> cspan = numbers;
cspan[0] = 0; // ERROR: cspan[0] is read-only
					

QSpan 可以是 fixed-size or variable-sized .

A variable-sized span is formed by omitting the second template argument (or setting it to std::dynamic_extent , which is, however, only available in C++20 builds), as seen in the example above.

A fixed-size span is formed by passing a number as the second template argument:

int numbers[] = {0, 1, 2};
QSpan<int, 3> span = numbers;
QSpan<const int, 3> = numbers; // also OK
					

As the name suggests, a fixed-size span's size () is fixed at compile-time whereas the size () of a variable-sized span is determined only at run-time.

A fixed-size span is not default-constructible (unless its extent is zero (0)). A variable-sized span is default-constructible and will have data() == nullptr and size() == 0 .

A fixed-size span can be implicitly converted into a variable-sized one. The opposite direction (variable-length into fixed-length) has the precondition that both span's sizes must match.

不像采用拥有容器, const is shallow in QSpan: you can still modify the data through a const QSpan (but not through a QSpan<const T> ),和 begin () 和 end () are not overloaded on const /non- const . There are cbegin () 和 cend (), though, that return const_iterators which prevent modification of the data even though T is not const:

int numbers[] = {0, 1, 2};
const QSpan<int> span = numbers;
span.front() = 42;   // OK, numbers[0] == 42 now
*span.begin() = 31;  // OK, numbers[0] == 31 now
*span.cbegin() = -1; // ERROR: cannot assign through a const_iterator
					

QSpan should be passed by value, not by reference-to-const:

void consume(QSpan<const int> data); // OK
void consume(const QSpan<const int> &data); // works, but is non-idiomatic and less efficient
					

QSpan<T,N> 文字类型 , regardless of whether T is a Literal Type or not.

QSpan vs. std::span

QSpan is closely modelled after std::span , but has a few differences which we'll discuss here. Since they both implicitly convert into each other, you're free to choose whichever one you like best in your own code.

  • QSpan is using the signed qsizetype as size_type whereas std::span 使用 size_t .
  • All QSpan constructors are implicit; many std::span ones are explicit .
  • QSpan can be constructed from rvalue owning containers, std::span can not.

The last two are required for source-compatibility when functions that took owning containers are converted to take QSpan instead, which is a vitally-important use-case in Qt. The use of qsizetype is for consistency with the rest of Qt containers. QSpan template arguments still use size_t to avoid introducing unnecessary error conditions (negative sizes).

兼容迭代器

QSpan can be constructed from an iterator and size or from an iterator pair, provided the iterators are compatible ones. Eventually, this should mean C++20 std::contiguous_iterator and std::sentinel_for , but while Qt still supports C++17, only raw pointers are considered contiguous iterators.

兼容范围

QSpan can also be constructed from a compatible range. A range is compatible if it has compatible iterators .

另请参阅 QList , QStringView , QLatin1StringView ,和 QUtf8StringView .

成员类型文档编制

[alias] QSpan:: const_iterator

别名化的 const T* and const_pointer ,分别。

另请参阅 const_pointer , iterator ,和 const_reverse_iterator .

[alias] QSpan:: const_pointer

别名化的 const T* and const element_type* ,分别。

This alias is provided for compatbility with the STL.

另请参阅 element_type , pointer , const_reference ,和 const_iterator .

[alias] QSpan:: const_reference

别名化的 const T& and const element_type& ,分别。

This alias is provided for compatbility with the STL.

另请参阅 element_type , reference ,和 const_pointer .

[alias] QSpan:: const_reverse_iterator

别名化的 std::reverse_iterator<const_iterator> .

另请参阅 const_iterator and reverse_iterator .

[alias] QSpan:: difference_type

An alias for qptrdiff. This differs from std::span .

This alias is provided for compatbility with the STL.

[alias] QSpan:: element_type

别名化的 T . Includes the const ,若有的话。

This alias is provided for compatbility with the STL.

另请参阅 value_type and pointer .

[alias] QSpan:: iterator

别名化的 T* and pointer , respectively. Includes the const ,若有的话。

另请参阅 pointer , const_iterator ,和 reverse_iterator .

[alias] QSpan:: pointer

别名化的 T* and element_type* , respectively. Includes the const ,若有的话。

This alias is provided for compatbility with the STL.

另请参阅 element_type , const_pointer , reference ,和 iterator .

[alias] QSpan:: reference

别名化的 T& and element_type& , respectively. Includes the const ,若有的话。

This alias is provided for compatbility with the STL.

另请参阅 element_type , const_reference ,和 pointer .

[alias] QSpan:: reverse_iterator

别名化的 std::reverse_iterator<iterator> . Includes the const ,若有的话。

另请参阅 iterator and const_reverse_iterator .

[alias] QSpan:: size_type

An alias for qsizetype. This differs from std::span .

This alias is provided for compatbility with the STL.

[alias] QSpan:: value_type

别名化的 T 。排除 const ,若有的话。

This alias is provided for compatbility with the STL.

另请参阅 element_type .

成员函数文档编制

[default] QSpan:: QSpan ( QSpan < T , E > && other )

[default] QSpan:: QSpan (const QSpan < T , E > & other )

[default] QSpan < T , E > &QSpan:: operator= ( QSpan < T , E > && other )

[default] QSpan < T , E > &QSpan:: operator= (const QSpan < T , E > & other )

[default] QSpan:: ~QSpan ()

These Special Member Functions are implicitly-defined.

注意: Moves are equivalent to copies. Only data () 和 size () are copied from span to span, not the referenced data.

[constexpr noexcept] template <typename S, size_t N, QSpan<T, E>::if_qualification_conversion = true> QSpan:: QSpan (const std::array < S , N > & arr )

[constexpr noexcept] template <size_t N> QSpan:: QSpan ( q20::type_identity_t < T > (&)[ N ] arr )

[constexpr noexcept] template <typename S, size_t N, QSpan<T, E>::if_qualification_conversion = true> QSpan:: QSpan ( std::array < S , N > & arr )

构造 QSpan referencing the data in the supplied array arr .

注意: This constructor participates in overload resolution only if

  • either N or extent are std::dynamic_extent or otherwise extent == N
  • and either S or const S are the same as T .

注意: q20::type_identity_t is a C++17 backport of C++20's std::type_identity_t .

[constexpr noexcept] template <typename S, size_t N, QSpan<T, E>::if_qualification_conversion = true> QSpan:: QSpan ( QSpan < S , N > other )

[constexpr noexcept] template <typename S, size_t N, QSpan<T, E>::if_qualification_conversion = true> QSpan:: QSpan ( std::span < S , N > other )

构造 QSpan referencing the data in the supplied span other .

注意: This constructor participates in overload resolution only if

  • either N or extent are std::dynamic_extent or extent == N
  • and either S or const S are the same as T .

[constexpr noexcept] bool QSpan:: empty () const

[noexcept] bool QSpan:: isEmpty () const

Returns whether the span is empty, that is, whether size() == 0 .

These functions do the same thing: empty () is provided for STL compatibility and isEmpty () is provided for Qt compatibility.

另请参阅 size () 和 size_bytes ().

[constexpr] QSpan < T > QSpan:: sliced ( QSpan < T , E > ::size_type pos ) const

[constexpr] QSpan < T > QSpan:: subspan ( QSpan < T , E > ::size_type pos ) const

Returns a variable-sized span of size size() - pos referencing the remainder of this span after dropping the first pos 元素。

pos must be non-negative.

This span must hold at least pos elements ( E >= pos and size () >= pos ), otherwise the behavior is undefined.

These functions do the same thing: subspan () is provided for STL compatibility and sliced () is provided for Qt compatibility.

另请参阅 subspan (), first (QSpan<T,E>::size_type), and last (QSpan<T,E>::size_type).

[constexpr] QSpan < T > QSpan:: sliced ( QSpan < T , E > ::size_type pos , QSpan < T , E > ::size_type n ) const

[constexpr] QSpan < T > QSpan:: subspan ( QSpan < T , E > ::size_type pos , QSpan < T , E > ::size_type n ) const

Returns a variable-sized span of size n referencing the n elements of this span starting at pos .

Both pos and n must be non-negative.

This span must hold at least pos + n elements ( E >= pos + n and size () >= pos + n ), otherwise the behavior is undefined.

These functions do the same thing: subspan () is provided for STL compatibility and sliced () is provided for Qt compatibility.

另请参阅 subspan (), first (QSpan<T,E>::size_type), and last (QSpan<T,E>::size_type).

[constexpr] template <typename It, QSpan<T, E>::if_compatible_iterator = true> QSpan:: QSpan ( It first , qsizetype count )

Constructs a QSpan referencing the data starting at first and having length count .

[first, count) must be a valid range.

注意: This constructor participates in overload resolution only if It is a compatible iterator .

[constexpr] template <typename It, QSpan<T, E>::if_compatible_iterator = true> QSpan:: QSpan ( It first , It last )

Constructs a QSpan referencing the data starting at first and having length ( last - first ).

[first, last) must be a valid range.

注意: This constructor participates in overload resolution only if It is a compatible iterator .

[constexpr] template <typename Range, QSpan<T, E>::if_compatible_range = true> QSpan:: QSpan ( Range && r )

Constructs a QSpan referencing the data in the supplied range r .

注意: This constructor participates in overload resolution only if Range is a compatible range .

[constexpr] QSpan:: QSpan ( std::initializer_list < QSpan < T , E > ::value_type > il )

Constructs a QSpan referencing the data in the supplied initializer list il .

注意: This constructor participates in overload resolution only if T is const -qualified.

注意: This constructor is noexcept only if E is std::dynamic_extent .

注意: E 不是 std::dynamic_extent and the size of il 不是 E , the behavior is undefined.

[default] QSpan:: QSpan ()

默认构造函数。

This constructor is only present if E is either zero (0) or std::dynamic_extent . In other words: only fixed-zero-sized or variable-sized spans are default-constructible.

另请参阅 extent .

[constexpr] QSpan < T , E > ::reference QSpan:: back () const

Returns a reference to the last element in the span.

The span must not be empty, otherwise the behavior is undefined.

另请参阅 operator[] (), front (), size (),和 empty ().

[constexpr noexcept] QSpan < T , E > ::iterator QSpan:: begin () const

Returns an interator pointing at the beginning of the span.

因为 QSpan iterators are just pointers, this is the same as calling data ().

另请参阅 end (), cbegin (), rbegin (), crbegin (),和 data ().

[constexpr noexcept] QSpan < T , E > ::const_iterator QSpan:: cbegin () const

返回 const_iterator pointing to the beginning of the span.

This will return a read-only iterator even if T 不是 const :

QSpan<int> span = ~~~;
*span.begin() = 42; // OK
*span.cbegin() = 42; // ERROR: cannot assign through a const_iterator
						

另请参阅 cend (), begin (), crbegin (), rbegin (),和 data ().

[constexpr noexcept] QSpan < T , E > ::const_iterator QSpan:: cend () const

返回 const_iterator pointing to one past the end of the span.

另请参阅 cbegin (), end (), crend (), rend (), data (),和 size ().

[constexpr noexcept] QSpan < T , E > ::const_reverse_iterator QSpan:: crbegin () const

返回 const_reverse_iterator pointing to the beginning of the reversed span.

另请参阅 crend (), rbegin (), cbegin (),和 begin ().

[constexpr noexcept] QSpan < T , E > ::const_reverse_iterator QSpan:: crend () const

返回 const_reverse_iterator pointing to one past the end of the reversed span.

另请参阅 crbegin (), rend (), cend (),和 end ().

[constexpr noexcept] QSpan < T , E > ::pointer QSpan:: data () const

Returns a pointer to the beginning of the span.

The same as calling begin ().

另请参阅 begin () 和 front ().

[constexpr noexcept] QSpan < T , E > ::iterator QSpan:: end () const

Returns an iterator pointing to one past the end of the span.

因为 QSpan iterators are just pointers, this it the same as calling data() + size() .

另请参阅 begin (), cend (), rend (), crend (), data (),和 size ().

[constexpr noexcept(...)] template <std::size_t Count> QSpan < T , Count > QSpan:: first () const

Returns a fixed-sized span of size Count referencing the first Count elements of *this .

The span must hold at least Count elements ( E >= Count and size () >= Count ), otherwise the behavior is undefined.

注意: This function does not throw any exception when "subspan_always_succeeds_v<Count>" is true.

另请参阅 first (QSpan<T,E>::size_type), last (),和 subspan ().

[constexpr] QSpan < T > QSpan:: first ( QSpan < T , E > ::size_type n ) const

Returns a variable-sized span of size n referencing the first n elements of *this .

n must be non-negative.

The span must hold at least n elements ( E >= n and size () >= n ), otherwise the behavior is undefined.

另请参阅 first<N> (), last (QSpan<T,E>::size_type), subspan (QSpan<T,E>::size_type), subspan (QSpan<T,E>::size_type, QSpan<T,E>::size_type), and sliced ().

[constexpr] QSpan < T , E > ::reference QSpan:: front () const

Returns a reference to the first element in the span.

The span must not be empty, otherwise the behavior is undefined.

另请参阅 operator[] (), back (), size (),和 empty ().

[constexpr noexcept(...)] template <std::size_t Count> QSpan < T , Count > QSpan:: last () const

Returns a fixed-sized span of size Count referencing the last Count elements of *this .

The span must hold at least Count elements ( E >= Count and size () >= Count ), otherwise the behavior is undefined.

注意: This function does not throw any exception when "subspan_always_succeeds_v<Count>" is true.

另请参阅 last (QSpan<T,E>::size_type), first (),和 subspan ().

[constexpr] QSpan < T > QSpan:: last ( QSpan < T , E > ::size_type n ) const

Returns a variable-sized span of size n referencing the last n elements of *this .

n must be non-negative.

The span must hold at least n elements ( E >= n and size () >= n ), otherwise the behavior is undefined.

另请参阅 last (), first (QSpan<T,E>::size_type), subspan (QSpan<T,E>::size_type), subspan (QSpan<T,E>::size_type, QSpan<T,E>::size_type), and sliced ().

[constexpr noexcept] QSpan < T , E > ::reverse_iterator QSpan:: rbegin () const

返回 reverse_iterator pointing to the beginning of the reversed span.

另请参阅 rend (), crbegin (), begin (),和 cbegin ().

[constexpr noexcept] QSpan < T , E > ::reverse_iterator QSpan:: rend () const

返回 reverse_iterator pointing to one past the end of the reversed span.

另请参阅 rbegin (), crend (), end (),和 cend ().

[constexpr noexcept] QSpan < T , E > ::size_type QSpan:: size () const

Returns the size of the span, that is, the number of elements it references.

另请参阅 size_bytes (), empty (),和 isEmpty ().

[constexpr noexcept] QSpan < T , E > ::size_type QSpan:: size_bytes () const

Returns the size of the span in bytes, that is, the number of elements multiplied by sizeof(T) .

另请参阅 size (), empty (),和 isEmpty ().

[constexpr noexcept(...)] template <std::size_t Offset> auto QSpan:: subspan () const

Returns a span of size E - Offset referencing the remainder of this span after dropping the first 偏移 元素。

*this is a variable-sized span, the return type is a variable-sized span, otherwise it is a fixed-sized span.

This span must hold at least 偏移 elements ( E >= 偏移 and size () >= 偏移 ), otherwise the behavior is undefined.

注意: This function does not throw any exception when "subspan_always_succeeds_v<Offset>" is true.

另请参阅 subspan (QSpan<T,E>::size_type), subspan(), first (),和 last ().

[constexpr noexcept(...)] template <std::size_t Offset, std::size_t Count> auto QSpan:: subspan () const

Returns a span of size Count referencing the Count elements of this span starting at 偏移 .

*this is a variable-sized span, the return type is a variable-sized span, otherwise it is a fixed-sized span.

This span must hold at least Offset + Count elements ( E >= Offset + Count and size () >= Offset + Count ), otherwise the behavior is undefined.

注意: This function does not throw any exception when "subspan_always_succeeds_v<Offset + Count>" is true.

另请参阅 subspan (QSpan<T,E>::size_type, QSpan<T,E>::size_type), subspan (), first (),和 last ().

[constexpr] QSpan < T , E > ::reference QSpan:: operator[] ( QSpan < T , E > ::size_type idx ) const

Returns a reference to the element at index idx in the span.

The index must be in range, that is, idx >= 0 and idx < size (), otherwise the behavior is undefined.

另请参阅 front (), back (), size (),和 empty ().

成员变量文档编制

const std::size_t QSpan:: extent

The second template argument of QSpan<T, E> , that is, E . This is std::dynamic_extent for variable-sized spans.

注意: While all other sizes and indexes in QSpan use qsizetype, this variable, like E , is actually of type size_t , for compatibility with std::span and std::dynamic_extent .

另请参阅 size ().