std::basic_ispanstream<CharT,Traits>::span

 

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

 

Input/output library

I/O manipulators

C-style I/O

Buffers

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (deprecated in C++98)

basic_syncbuf (C++20)

Streams

Abstractions

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

File I/O

basic_ifstream

basic_ofstream

basic_fstream

String I/O

basic_istringstream

basic_ostringstream

basic_stringstream

Array I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (deprecated in C++98)

ostrstream (deprecated in C++98)

strstream (deprecated in C++98)

Synchronized Output

basic_osyncstream (C++20)

Types

streamoff

streamsize

fpos

Error category interface

iostream_category (C++11)

io_errc (C++11)

 

std::basic_ispanstream

Member functions

basic_ispanstream::basic_ispanstream (C++23)

basic_ispanstream::operator= (C++23)

basic_ispanstream::swap (C++23)

basic_ispanstream::rdbuf (C++23)

Underlying buffer operations

basic_ispanstream::span (C++23)

Non-member functions

swap(std::basic_ipanstream) (C++23)

 

std::span<const CharT> span() const noexcept;	(1)	(since C++23)
void span( std::span<CharT> s ) noexcept;	(2)	(since C++23)
template< class ROS > void span( ROS&& r ) noexcept;	(3)	(since C++23)

1) Gets a span referencing the written area if std::ios_base::out is set in the open mode of the wrapped std::basic_spanbuf, or a span referencing the underlying buffer otherwise.

2) Makes the wrapped std::basic_spanbuf perform I/O on the buffer referenced by s.

3) Same as (2), except that s is obtained as if by
std::span<const CharT> cs{std::forward<ROS>(r)};
std::span<CharT> s{const_cast<CharT*>(cs.data()), cs.size()};
. This overload participates in overload resolution only if ROS models borrowed_range, std::convertible_to<ROS, std::span<CharT>> is false, and std::convertible_to<ROS, std::span<const CharT>> is true.

Parameters

s	-	std::span referencing the storage to be use as the new underlying buffer of stream
r	-	borrowed_range to be use as the new underlying buffer of stream

Return value

1) A std::span referencing the underlying buffer or written area, depending on the open mode of the wrapped std::basic_spanbuf.

2-3) (none)

See also

span (C++23)

obtains or initializes an underlying buffer according to mode (public member function of std::basic_spanbuf<CharT,Traits>)