std::ranges::owning_view

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Ranges library

Range access
begin cbegin end cend	rbegin crbegin rend crend	size ssize data cdata	empty
Range conversions
to (C++23)
Range primitives
range_size_trange_difference_t range_value_t	range_reference_trange_const_reference_trange_rvalue_reference_t   (C++23)	iterator_tconst_iterator_tsentinel_t (C++23)
Dangling iterator handling
dangling	borrowed_iterator_t	borrowed_subrange_t
Range concepts
range borrowed_range    sized_range constant_range (C++23)	common_range view viewable_range	input_range output_range forward_range	bidirectional_range random_access_range contiguous_range
Views
view_interface	subrange
Factories
empty_viewviews::empty iota_viewviews::iota	single_viewviews::single basic_istream_viewviews::istream	repeat_viewviews::repeat (C++23)(C++23)
Adaptors
ref_view views::all_tviews::all common_viewviews::common owning_view views::counted reverse_viewviews::reverse zip_viewviews::zip (C++23)(C++23) as_const_viewviews::as_const (C++23)(C++23) as_rvalue_viewviews::as_rvalue (C++23)(C++23)	take_viewviews::take take_while_viewviews::take_while drop_viewviews::drop drop_while_viewviews::drop_while zip_transform_viewviews::zip_transform (C++23)(C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23)   cartesian_product_viewviews::cartesian_product (C++23)(C++23)	elements_viewviews::elements keys_viewviews::keys values_viewviews::values transform_viewviews::transform adjacent_viewviews::adjacent (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) stride_viewviews::stride (C++23)(C++23)	filter_viewviews::filter join_viewviews::join split_viewviews::split lazy_split_viewviews::lazy_split join_with_viewviews::join_with (C++23)(C++23) chunk_viewviews::chunk (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23)
Range adaptor objects
Range adaptor closure objects
Helper items
copyable-box	simple-view

 

Defined in header <ranges>
template<ranges::range R>     requires std::movable<R> && (!/*is-initializer-list*/<R>) class owning_view : public ranges::view_interface<owning_view<R>>		(since C++20)

owning_view is a view that has unique ownership of a range. It is move only and stores that range within it.

The constant /*is-initializer-list*/<R> in the requires-clause is true if and only if std::remove_cvref_t<R> is a specialization of std::initializer_list.

Data members

Typical implementations of owning_view have only one non-static data member: the underlying range of type R. The member is shown as r_ here (the name is exposition-only).

Member functions

(constructor) (C++20)	constructs a owning_view by value-initializing or move-constructing the stored range (public member function)
operator= (C++20)	move-assigns the stored range (public member function)
base (C++20)	returns a reference to the stored range (public member function)
begin (C++20)	returns the beginning iterator of the stored range (public member function)
end (C++20)	returns the sentinel of the stored range (public member function)
empty (C++20)	checks whether the stored range is empty (public member function)
size (C++20)	returns the size of the stored sized_range (public member function)
data (C++20)	returns the pointer to the beginning of the stored contiguous_range (public member function)
Inherited from std::ranges::view_interface
operator bool (C++20)	Returns whether the derived view is not empty. Provided if ranges::empty is applicable to it. (public member function of std::ranges::view_interface<D>)
front (C++20)	Returns the first element in the derived view. Provided if it satisfies forward_range. (public member function of std::ranges::view_interface<D>)
back (C++20)	Returns the last element in the derived view. Provided if it satisfies bidirectional_range and common_range. (public member function of std::ranges::view_interface<D>)
operator[] (C++20)	Returns the nth element in the derived view. Provided if it satisfies random_access_range. (public member function of std::ranges::view_interface<D>)

std::ranges::owning_view::owning_view

owning_view() requires std::default_initializable<R> = default;	(1)	(since C++20)
owning_view( owning_view&& other ) = default;	(2)	(since C++20)
constexpr owning_view( R&& t );	(3)	(since C++20)
owning_view( const owning_view& ) = delete;	(4)	(since C++20)

1) Default constructor. Value-initializes the stored range by its default member initializer (= R()).

2) Move constructor. Move constructs the stored range from that of other.

3) Move constructs the stored range from t.

4) Copy constructor is deleted. owning_view is move-only.

Parameters

other	-	another owning_view to move from
t	-	range to move from

std::ranges::owning_view::operator=

owning_view& operator=( owning_view&& other ) = default;	(1)	(since C++20)
owning_view& operator=( const owning_view& ) = delete;	(2)	(since C++20)

1) Move assignment operator. Move assigns the stored range from that of other.

2) Copy assignment operator is deleted. owning_view is move-only.

Parameters

other

-

another owning_view to move from

Return value

*this.

std::ranges::owning_view::base

constexpr R& base() & noexcept;	(1)	(since C++20)
constexpr const R& base() const & noexcept;	(2)	(since C++20)
constexpr R&& base() && noexcept;	(3)	(since C++20)
constexpr const R&& base() const && noexcept;	(4)	(since C++20)

Returns a reference to the stored range, keeping value category and const-qualification.

1-2) Equivalent to return r_;.

3-4) Equivalent to return std::move(r_);.

std::ranges::owning_view::begin

constexpr ranges::iterator_t<R> begin();	(1)	(since C++20)
constexpr auto begin() const requires ranges::range<const R>;	(2)	(since C++20)

Equivalent to return ranges::begin(r_);.

std::ranges::owning_view::end

constexpr ranges::sentinel_t<R> end();	(1)	(since C++20)
constexpr auto end() const requires ranges::range<const R>;	(2)	(since C++20)

Equivalent to return ranges::end(r_);.

std::ranges::owning_view::empty

constexpr bool empty() requires requires { ranges::empty(r_); };	(1)	(since C++20)
constexpr bool empty() const requires requires { ranges::empty(r_); };	(2)	(since C++20)

Equivalent to return ranges::empty(r_);.

std::ranges::owning_view::size

constexpr auto size() requires ranges::sized_range<R>;	(1)	(since C++20)
constexpr auto size() const requires ranges::sized_range<const R>;	(2)	(since C++20)

Equivalent to return ranges::size(r_);.

std::ranges::owning_view::data

constexpr auto data() requires ranges::contiguous_range<R>;	(1)	(since C++20)
constexpr auto data() const requires ranges::contiguous_range<const R>;	(2)	(since C++20)

Equivalent to return ranges::data(r_);.

Helper templates

template<class T> inline constexpr bool enable_borrowed_range<std::ranges::owning_view<T>> =     std::ranges::enable_borrowed_range<T>;		(since C++20)

This specialization of std::ranges::enable_borrowed_range makes owning_view satisfy borrowed_range when the underlying range satisfies it.

Example

Run this code

#include <ranges>
#include <string>
#include <cassert>
#include <iostream>
 
int main()
{
    using namespace std::literals;
    std::ranges::owning_view ov{ "cosmos"s }; // the deduced type of R is std::string;
                                              // `ov` is the only owner of this string
    std::cout
        << std::boolalpha
        << "call empty() : " << ov.empty() << '\n'
        << "call size()  : " << ov.size() << '\n'
        << "call front() : " << ov.front() << '\n' // same as *(ov.begin())
        << "call back()  : " << ov.back() << '\n' // equals to *(ov.end()-1)
        << "call data()  : " << ov.data() << '\n'
        << "call base()  : " << ov.base().size() << '\n' // ~> ov.size()
        << "sizeof(ov)   : " << sizeof(ov) << '\n' // typically equals to sizeof(R)
        << "range-for    : \"";
 
    for (const char c: ov)
        std::cout << c;
    std::cout << "\"\n";
 
    std::ranges::owning_view<std::string> ov2;
    assert(ov2.empty());
//  ov2 = ov; // compile-time error: copy assignment operator is deleted
    ov2 = std::move(ov); // OK
    assert(ov.empty());
    assert(ov2.size() == 6);
}

Possible output:

call empty() : false
call size()  : 6
call front() : c
call back()  : s
call data()  : cosmos
call base()  : 6
sizeof(ov)   : 32
range-for    : "cosmos"

See also

ranges::ref_view (C++20)	a view of the elements of some other range (class template)
views::all_tviews::all (C++20)	a view that includes all elements of a range (alias template) (range adaptor object)