std::ranges::borrowed_range, std::ranges::enable_borrowed_range

Определено в заголовочном файле <ranges>

Определено в заголовочном файле `<ranges>`
template< class R > concept borrowed_range = ranges::range<R> && (std::is_lvalue_reference_v<R> \|\| ranges::enable_borrowed_range<std::remove_cvref_t<R>>);	(1)	(начиная с C++20)
template< class R > constexpr bool enable_borrowed_range = false;	(2)	(начиная с C++20)

template< class R >
concept borrowed_range =
    ranges::range<R> &&
    (std::is_lvalue_reference_v<R> ||
     ranges::enable_borrowed_range<std::remove_cvref_t<R>>);

(1)

(начиная с C++20)

template< class R >
constexpr bool enable_borrowed_range = false;

(2)

(начиная с C++20)

1) Концепт borrowed_range задаёт требования к диапазону, позволяющие функции принимать его по значению и возвращать полученные из него итераторы без риска их висячего состояния.

2) Шаблон переменной enable_borrowed_range используется для указания того, является ли range borrowed_range. Первичный шаблон определён как false.

Семантические требования

Пусть U — это std::remove_reference_t<T>, если T является ссылочным типом rvalue, и T в противном случае. Для переменной u типа U, T моделирует borrowed_range только в том случае, если корректность итераторов, полученных из u, не зависит от времени жизни этой переменной.

Специализации

Программа может специализировать enable_borrowed_range значением true для cv-неквалифицированных типов, определённых программой, которые моделируют borrowed_range, и значением false для типов, которые его не моделируют. Такие специализации должны быть пригодны для использования в константном выражении и иметь тип constbool.

Безусловно заимствующие диапазоны в стандартной библиотеке

Специализации enable_borrowed_range для всех специализаций следующих стандартных шаблонов определены как true:

Условно заимствующие диапазоны в стандартной библиотеке

Специализация enable_borrowed_range для следующих стандартных адаптеров диапазонов определена как true тогда и только тогда, когда std::ranges::enable_borrowed_range<V> имеет значение true, где V — тип базового представления:

(начиная с C++23)

std::ranges::enumerate_view

(начиная с C++23)

std::ranges::take_view

std::ranges::as_input_view

(начиная с C++26)

Базовое представление V также должно удовлетворять требованиям forward_range.

Специализация enable_borrowed_range для следующих стандартных адаптеров диапазонов определена как true тогда и только тогда, когда (std::ranges::enable_borrowed_range<Vs> && ...) имеет значение true, где Vs... — все типы представлений, к которым применяется адаптер:

std::ranges::zip_view

(начиная с C++23)

Пример

Демонстрирует специализации enable_borrowed_range для типов, определённых программой. Такие специализации защищают от потенциально висячих результатов.

#include <algorithm>
#include <array>
#include <cstddef>
#include <iostream>
#include <ranges>
#include <span>
#include <type_traits>

template<typename T, std::size_t N>
struct MyRange : std::array<T, N> {};

template<typename T, std::size_t N>
constexpr bool std::ranges::enable_borrowed_range<MyRange<T, N>> = false;

template<typename T, std::size_t N>
struct MyBorrowedRange : std::span<T, N> {};

template<typename T, std::size_t N>
constexpr bool std::ranges::enable_borrowed_range<MyBorrowedRange<T, N>> = true;

int main()
{
    static_assert(std::ranges::range<MyRange<int, 8>>);
    static_assert(std::ranges::borrowed_range<MyRange<int, 8>> == false);
    static_assert(std::ranges::range<MyBorrowedRange<int, 8>>);
    static_assert(std::ranges::borrowed_range<MyBorrowedRange<int, 8>> == true);
    
    auto getMyRangeByValue = []{ return MyRange<int, 4>{{1, 2, 42, 3}}; };
    auto dangling_iter = std::ranges::max_element(getMyRangeByValue());
    static_assert(std::is_same_v<std::ranges::dangling, decltype(dangling_iter)>);
    // *dangling_iter; // compilation error (i.e. dangling protection works.)
    
    auto my = MyRange<int, 4>{{1, 2, 42, 3}};
    auto valid_iter = std::ranges::max_element(my);
    std::cout << *valid_iter << ' '; // OK: 42
    
    auto getMyBorrowedRangeByValue = []
    {
        static int sa[4]{1, 2, 42, 3};
        return MyBorrowedRange<int, std::size(sa)>{sa};
    };
    auto valid_iter2 = std::ranges::max_element(getMyBorrowedRangeByValue());
    std::cout << *valid_iter2 << '\n'; // OK: 42
}

Вывод:

42 42

См. также

ranges::dangling

(C++20)

тип-заполнитель, указывающий на то, что итератор или subrange не следует возвращать, поскольку он будет висячим
(класс)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/ranges/borrowed_range