Standard library header <syncstream> (C++20)

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros(C++20)

Language support library

Concepts library(C++20)

Diagnostics library

Memory management library

Metaprogramming library(C++11)

General utilities library

Containers library

Iterators library

Ranges library(C++20)

Algorithms library

Strings library

Text processing library

Numerics library

Date and time library

Input/output library

Filesystem library(C++17)

Concurrency support library(C++11)

Execution control library(C++26)

Technical specifications

Symbols index

External libraries

 

Standard library headers

Language support <cfloat> <climits> <compare>(C++20) <contracts>(C++26) <coroutine>(C++20) <csetjmp> <csignal> <cstdarg> <cstddef> <cstdint>(C++11) <cstdlib> <exception> <initializer_list>(C++11)    <limits> <new> <source_location>(C++20) <stdfloat>(C++23) <typeinfo> <version>(C++20) Concepts <concepts>(C++20) Diagnostics <cassert> <cerrno> <debugging>(C++26) <stacktrace>(C++23) <stdexcept> <system_error>(C++11) Memory management <memory> <memory_resource>(C++17) <scoped_allocator>(C++11) Metaprogramming <type_traits>(C++11) <ratio>(C++11)

General utilities <any>(C++17) <bitset> <bit>(C++20) <charconv>(C++17) <expected>(C++23) <format>(C++20) <functional> <optional>(C++17) <stdbit.h>(C++26) <tuple>(C++11) <typeindex>(C++11) <utility> <variant>(C++17) Containers <array>(C++11) <deque> <flat_map>(C++23) <flat_set>(C++23) <forward_list>(C++11) <hive>(C++26) <inplace_vector>(C++26)    <list> <map> <mdspan>(C++23) <queue> <set> <span>(C++20) <stack> <unordered_map>(C++11) <unordered_set>(C++11) <vector> Iterators <iterator> Ranges <generator>(C++23) <ranges>(C++20)

Algorithms <algorithm> <numeric> Strings <cctype> <cstring> <cuchar>(C++11) <cwchar> <cwctype> <string_view>(C++17) <string> Text processing <clocale> <codecvt>(C++11/17/26*) <locale> <regex>(C++11) <text_encoding>(C++26)    Numerics <cfenv>(C++11) <cmath> <complex> <linalg>(C++26) <numbers>(C++20) <random>(C++11) <simd>(C++26) <stdckdint.h>(C++26) <valarray> Time <chrono>(C++11) <ctime> C compatibility <ccomplex>(C++11/17/20*) <ciso646>(until C++20) <cstdalign>(C++11/17/20*) <cstdbool>(C++11/17/20*) <ctgmath>(C++11/17/20*)

Input/output <cinttypes>(C++11) <cstdio> <filesystem>(C++17) <fstream> <iomanip> <iosfwd> <iostream> <ios> <istream> <ostream> <print>(C++23) <spanstream>(C++23) <sstream> <streambuf> <strstream>(C++98/26*) <syncstream>(C++20) Concurrency support <atomic>(C++11) <barrier>(C++20) <condition_variable>(C++11) <future>(C++11) <hazard_pointer>(C++26) <latch>(C++20) <mutex>(C++11) <rcu>(C++26) <semaphore>(C++20) <shared_mutex>(C++14) <stdatomic.h>(C++23) <stop_token>(C++20) <thread>(C++11) Execution support <execution>(C++17)

 

This header is part of the Input/Output library.

Includes
<ostream>	std::basic_ostream, std::basic_iostream class templates and typedefs
Classes
basic_syncbuf (C++20)	synchronized output device wrapper (class template)
basic_osyncstream (C++20)	synchronized output stream wrapper (class template)
syncbuf(C++20)	std::basic_syncbuf<char> (typedef)
wsyncbuf(C++20)	std::basic_syncbuf<wchar_t> (typedef)
osyncstream(C++20)	std::basic_osyncstream<char> (typedef)
wosyncstream(C++20)	std::basic_osyncstream<wchar_t> (typedef)
Functions
std::swap(std::basic_syncbuf) (C++20)	specializes the std::swap algorithm (function template)

Synopsis

#include <ostream>   namespace std {template<class CharT, class Traits = char_traits<CharT>, class Allocator = allocator<CharT>>class basic_syncbuf;   using syncbuf = basic_syncbuf<char>;using wsyncbuf = basic_syncbuf<wchar_t>;   template<class CharT, class Traits = char_traits<CharT>, class Allocator = allocator<CharT>>class basic_osyncstream;   using osyncstream = basic_osyncstream<char>;using wosyncstream = basic_osyncstream<wchar_t>;}

Class template std::basic_syncbuf

namespace std {template<class CharT, class Traits = char_traits<CharT>, class Allocator = allocator<CharT>>class basic_syncbuf :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;using allocator_type = Allocator;   using streambuf_type = basic_streambuf<CharT, Traits>;   // construction and destruction basic_syncbuf(): basic_syncbuf(nullptr){}explicit basic_syncbuf(streambuf_type* obuf): basic_syncbuf(obuf, Allocator()){} basic_syncbuf(streambuf_type*, const Allocator&); basic_syncbuf(basic_syncbuf&&); ~basic_syncbuf();   // assignment and swap basic_syncbuf& operator=(basic_syncbuf&&);void swap(basic_syncbuf&);   // member functionsbool emit(); streambuf_type* get_wrapped()constnoexcept; allocator_type get_allocator()constnoexcept;void set_emit_on_sync(bool)noexcept;   protected:// overridden virtual functionsint sync() override;   private: streambuf_type* wrapped;// exposition onlybool emit_on_sync{};// exposition only};   // specialized algorithmstemplate<class CharT, class Traits, class Allocator>void swap(basic_syncbuf<CharT, Traits, Allocator>&, basic_syncbuf<CharT, Traits, Allocator>&);}

Class template std::basic_osyncstream

namespace std {template<class CharT, class Traits = char_traits<CharT>, class Allocator = allocator<CharT>>class basic_osyncstream :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;   using allocator_type = Allocator;using streambuf_type = basic_streambuf<CharT, Traits>;using syncbuf_type = basic_syncbuf<CharT, Traits, Allocator>;   // construction and destruction basic_osyncstream(streambuf_type*, const Allocator&);explicit basic_osyncstream(streambuf_type* obuf): basic_osyncstream(obuf, Allocator()){} basic_osyncstream(basic_ostream<CharT, Traits>& os, const Allocator& allocator): basic_osyncstream(os.rdbuf(), allocator){}explicit basic_osyncstream(basic_ostream<CharT, Traits>& os): basic_osyncstream(os, Allocator()){} basic_osyncstream(basic_osyncstream&&)noexcept; ~basic_osyncstream();   // assignment basic_osyncstream& operator=(basic_osyncstream&&)noexcept;   // member functionsvoid emit(); streambuf_type* get_wrapped()constnoexcept; syncbuf_type* rdbuf()constnoexcept{returnconst_cast<syncbuf_type*>(addressof(sb));}   private: syncbuf_type sb;// exposition only};}