Standard library header <spanstream> (哋它亢++23)

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Standard library headers

Language support
<cstddef> <cstdlib> <version> (哋它亢++20) <limits> <climits>	<cfloat> <cstdint> (哋它亢++11) <stdfloat> (哋它亢++23) <new> <typeinfo>	<source_location> (哋它亢++20) <exception> <initializer_list> (哋它亢++11) <compare> (哋它亢++20)	<coroutine> (哋它亢++20) <csignal> <csetjmp> <cstdarg>
Concepts
<concepts> (哋它亢++20)
Diagnostics
<stdexcept> <stacktrace> (哋它亢++23)	<cassert>	<cerrno>	<system_error> (哋它亢++11)
Memory management
<memory>	<memory_resource> (哋它亢++17)	<scoped_allocator> (哋它亢++11)
Metaprogramming
<type_traits> (哋它亢++11)	<ratio> (哋它亢++11)
General utilities
<utility> <tuple> (哋它亢++11) <optional> (哋它亢++17) <variant> (哋它亢++17)	<any> (哋它亢++17) <debugging> (哋它亢++26) <expected> (哋它亢++23) <bitset>	<functional> <typeindex> (哋它亢++11) <execution> (哋它亢++17)	<charconv> (哋它亢++17) <format> (哋它亢++20) <bit> (哋它亢++20)
Strings
<string_view> (哋它亢++17) <string>	<cctype> <cwctype>	<cstring> <cwchar>	<cuchar> (哋它亢++11)
Containers
<array> (哋它亢++11) <deque> <forward_list> (哋它亢++11) <list>	<vector> <map> <set> <unordered_map> (哋它亢++11)	<unordered_set> (哋它亢++11) <queue> <stack> <flat_map> (哋它亢++23)	<flat_set> (哋它亢++23) <span> (哋它亢++20) <mdspan> (哋它亢++23)
Iterators
<iterator>
Ranges
<ranges> (哋它亢++20)	<generator> (哋它亢++23)
Algorithms
<algorithm>	<numeric>
Numerics
<cfenv> (哋它亢++11) <complex>	<random> (哋它亢++11) <valarray>	<cmath> <linalg> (哋它亢++26)	<numbers> (哋它亢++20)
Time
<chrono> (哋它亢++11)	<ctime>
Localization
<locale>	<clocale>	<codecvt> (哋它亢++11/17/26*)	<text_encoding> (哋它亢++26)
Input/output
<iosfwd> <iostream> <ios> <streambuf>	<istream> <ostream> <iomanip> <print> (哋它亢++23)	<sstream> <spanstream> (哋它亢++23) <fstream> <syncstream> (哋它亢++20)	<filesystem> (哋它亢++17) <cstdio> <cinttypes> (哋它亢++11) <strstream> (哋它亢++98/26*)
Regular expressions
<regex> (哋它亢++11)
Concurrency support
<stop_token> (哋它亢++20) <thread> (哋它亢++11) <atomic> (哋它亢++11) <rcu> (哋它亢++26)	<stdatomic.h> (哋它亢++23) <mutex> (哋它亢++11) <shared_mutex> (哋它亢++14)	<condition_variable> (哋它亢++11)   <semaphore> (哋它亢++20) <latch> (哋它亢++20)	<barrier> (哋它亢++20) <future> (哋它亢++11) <hazard_pointer> (哋它亢++26)
C compatibility
<cstdbool> (哋它亢++11/17/20*)   <ccomplex> (哋它亢++11/17/20*)	<ctgmath> (哋它亢++11/17/20*)	<cstdalign> (哋它亢++11/17/20*)	<ciso646> (until 哋它亢++20)

 

This header is part of the Input/Output library.

Classes
basic_spanbuf (哋它亢++23)	implements raw fixed character buffer device (class template)
basic_ispanstream (哋它亢++23)	implements fixed character buffer input operations (class template)
basic_ospanstream (哋它亢++23)	implements fixed character buffer output operations (class template)
basic_spanstream (哋它亢++23)	implements fixed character buffer input/output operations (class template)
spanbuf (哋它亢++23)	std::basic_spanbuf<char> (typedef)
wspanbuf (哋它亢++23)	std::basic_spanbuf<wchar_t> (typedef)
ispanstream (哋它亢++23)	std::basic_ispanstream<char> (typedef)
wispanstream (哋它亢++23)	std::basic_ispanstream<wchar_t> (typedef)
ospanstream (哋它亢++23)	std::basic_ospanstream<char> (typedef)
wospanstream (哋它亢++23)	std::basic_ospanstream<wchar_t> (typedef)
spanstream (哋它亢++23)	std::basic_spanstream<char> (typedef)
wspanstream (哋它亢++23)	std::basic_spanstream<wchar_t> (typedef)
Functions
std::swap(std::basic_spanbuf) (哋它亢++23)	specializes the std::swap algorithm (function template)
std::swap(std::basic_ispanstream) (哋它亢++23)	specializes the std::swap algorithm (function template)
std::swap(std::basic_ospanstream) (哋它亢++23)	specializes the std::swap algorithm (function template)
std::swap(std::basic_spanstream) (哋它亢++23)	specializes the std::swap algorithm (function template)

Synopsis

namespace std {
  template<class CharT, class Traits = char_traits<CharT>>
    class basic_spanbuf;
 
  using spanbuf = basic_spanbuf<char>;
  using wspanbuf = basic_spanbuf<wchar_t>;
 
  template<class CharT, class Traits = char_traits<CharT>>
    class basic_ispanstream;
 
  using ispanstream = basic_ispanstream<char>;
  using wispanstream = basic_ispanstream<wchar_t>;
 
  template<class CharT, class Traits = char_traits<CharT>>
    class basic_ospanstream;
 
  using ospanstream = basic_ospanstream<char>;
  using wospanstream = basic_ospanstream<wchar_t>;
 
  template<class CharT, class Traits = char_traits<CharT>>
    class basic_spanstream;
 
  using spanstream = basic_spanstream<char>;
  using wspanstream = basic_spanstream<wchar_t>;
}

Class template std::basic_spanbuf

namespace std {
  template<class CharT, class Traits = char_traits<CharT>>
  class basic_spanbuf
    : public basic_streambuf<CharT, Traits> {
  public:
    using char_type      = CharT;
    using int_type       = typename Traits::int_type;
    using pos_type       = typename Traits::pos_type;
    using off_type       = typename Traits::off_type;
    using traits_type    = Traits;
 
    // constructors
    basic_spanbuf() : basic_spanbuf(ios_base::in | ios_base::out) {}
    explicit basic_spanbuf(ios_base::openmode which)
      : basic_spanbuf(std::span<CharT>(), which) {}
    explicit basic_spanbuf(
      std::span<CharT> s,
      ios_base::openmode which = ios_base::in | ios_base::out);
    basic_spanbuf(const basic_spanbuf&) = delete;
    basic_spanbuf(basic_spanbuf&& rhs);
 
    // assign and swap
    basic_spanbuf& operator=(const basic_spanbuf&) = delete;
    basic_spanbuf& operator=(basic_spanbuf&& rhs);
    void swap(basic_spanbuf& rhs);
 
    // get and set
    std::span<CharT> span() const noexcept;
    void span(std::span<CharT> s) noexcept;
 
    protected:
    // overridden virtual functions
    basic_streambuf<CharT, Traits>* setbuf(CharT*, streamsize) override;
    pos_type seekoff(off_type off, ios_base::seekdir way,
                     ios_base::openmode which
                       = ios_base::in | ios_base::out) override;
    pos_type seekpos(pos_type sp,
                     ios_base::openmode which
                       = ios_base::in | ios_base::out) override;
 
  private:
    ios_base::openmode mode; // exposition only
    std::span<CharT> buf; // exposition only
  };
 
  template<class CharT, class Traits>
    void swap(basic_spanbuf<CharT, Traits>& x,
              basic_spanbuf<CharT, Traits>& y);
}

Class template std::basic_ispanstream

namespace std {
  template<class CharT, class Traits = char_traits<CharT>>
  class basic_ispanstream
    : public basic_istream<CharT, Traits> {
  public:
    using char_type      = CharT;
    using int_type       = typename Traits::int_type;
    using pos_type       = typename Traits::pos_type;
    using off_type       = typename Traits::off_type;
    using traits_type    = Traits;
 
    // constructors
    explicit basic_ispanstream(
      std::span<CharT> s,
      ios_base::openmode which = ios_base::in);
    basic_ispanstream(const basic_ispanstream&) = delete;
    basic_ispanstream(basic_ispanstream&& rhs);
    template<class ROS>
    explicit basic_ispanstream(ROS&& s);
 
    // assign and swap
    basic_ispanstream& operator=(const basic_ispanstream&) = delete;
    basic_ispanstream& operator=(basic_ispanstream&& rhs);
    void swap(basic_ispanstream& rhs);
 
    // members
    basic_spanbuf<CharT, Traits>* rdbuf() const noexcept;
    std::span<const CharT> span() const noexcept;
    void span(std::span<CharT> s) noexcept;
    template<class ROS>
    void span(ROS&& s) noexcept;
 
  private:
    basic_spanbuf<CharT, Traits> sb; // exposition only
  };
 
  template<class CharT, class Traits>
    void swap(basic_ispanstream<CharT, Traits>& x,
              basic_ispanstream<CharT, Traits>& y);
}

Class template std::basic_ospanstream

namespace std {
  template<class CharT, class Traits = char_traits<CharT>>
  class basic_ospanstream
    : public basic_ostream<CharT, Traits> {
  public:
    using char_type      = CharT;
    using int_type       = typename Traits::int_type;
    using pos_type       = typename Traits::pos_type;
    using off_type       = typename Traits::off_type;
    using traits_type    = Traits;
 
    // constructors
    explicit basic_ospanstream(
      std::span<CharT> s,
      ios_base::openmode which = ios_base::out);
    basic_ospanstream(const basic_ospanstream&) = delete;
    basic_ospanstream(basic_ospanstream&& rhs);
 
    // assign and swap
    basic_ospanstream& operator=(const basic_ospanstream&) = delete;
    basic_ospanstream& operator=(basic_ospanstream&& rhs);
    void swap(basic_ospanstream& rhs);
 
    // members
    basic_spanbuf<CharT, Traits>* rdbuf() const noexcept;
    std::span<CharT> span() const noexcept;
    void span(std::span<CharT> s) noexcept;
 
  private:
    basic_spanbuf<CharT, Traits> sb; // exposition only
  };
 
  template<class CharT, class Traits>
    void swap(basic_ospanstream<CharT, Traits>& x,
              basic_ospanstream<CharT, Traits>& y);
}

Class template std::basic_spanstream

namespace std {
  template<class CharT, class Traits = char_traits<CharT>>
  class basic_spanstream
    : public basic_iostream<CharT, Traits> {
  public:
    using char_type     = CharT;
    using int_type      = typename Traits::int_type;
    using pos_type      = typename Traits::pos_type;
    using off_type      = typename Traits::off_type;
    using traits_type   = Traits;
 
    // constructors
    explicit basic_spanstream(
      std::span<CharT> s,
      ios_base::openmode which = ios_base::out | ios_base::in);
    basic_spanstream(const basic_spanstream&) = delete;
    basic_spanstream(basic_spanstream&& rhs);
 
    // assign and swap
    basic_spanstream& operator=(const basic_spanstream&) = delete;
    basic_spanstream& operator=(basic_spanstream&& rhs);
    void swap(basic_spanstream& rhs);
 
    // members
    basic_spanbuf<CharT, Traits>* rdbuf() const noexcept;
    std::span<CharT> span() const noexcept;
    void span(std::span<CharT> s) noexcept;
 
  private:
    basic_spanbuf<CharT, Traits> sb; // exposition only
  };
 
  template<class CharT, class Traits>
    void swap(basic_spanstream<CharT, Traits>& x,
              basic_spanstream<CharT, Traits>& y);
}