std::basic_osyncstream

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

輸入/輸出庫

I/O 操縱器

列印函式 (C++23)

C 風格 I/O

緩衝區

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

流

抽象

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

檔案 I/O

basic_ifstream

basic_ofstream

basic_fstream

字串 I/O

basic_istringstream

basic_ostringstream

basic_stringstream

陣列 I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同步輸出

basic_osyncstream (C++20)

型別

streamoff

streamsize

fpos

錯誤類別介面

iostream_category (C++11)

io_errc (C++11)

 

std::basic_osyncstream

公開成員函式

basic_osyncstream::basic_osyncstream (C++20)

basic_osyncstream::operator= (C++20)

basic_osyncstream::~basic_osyncstream (C++20)

basic_osyncstream::rdbuf (C++20)

basic_osyncstream::get_wrapped (C++20)

basic_osyncstream::emit (C++20)

 

定義於標頭檔案 <syncstream>
template<     class CharT,     class Traits = std::char_traits<CharT>,     class Allocator = std::allocator<CharT> > class basic_osyncstream : public std::basic_ostream<CharT, Traits>		(C++20 起)

類模板 std::basic_osyncstream 是 std::basic_syncbuf 的一個便捷包裝器。它提供了一種機制來同步寫入同一流的執行緒。

它可以與命名變數一起使用

{
    std::osyncstream synced_out(std::cout); // synchronized wrapper for std::cout
    synced_out << "Hello, ";
    synced_out << "World!";
    synced_out << std::endl; // flush is noted, but not yet performed
    synced_out << "and more!\n";
} // characters are transferred and std::cout is flushed

也可以與臨時變數一起使用

std::osyncstream(std::cout) << "Hello, " << "World!" << '\n';

它保證所有寫入到同一最終目標緩衝區（上述示例中的 std::cout）的輸出都不會發生資料競爭，並且不會以任何方式交錯或損壞，只要每次寫入該最終目標緩衝區都透過（可能是不同的）std::basic_osyncstream 例項進行。

std::basic_osyncstream 的典型實現只包含一個成員：包裝的 std::basic_syncbuf。

繼承圖

提供了用於常見字元型別的幾個 typedef

定義於標頭檔案 <syncstream>
型別	定義
std::osyncstream	std::basic_osyncstream<char>
std::wosyncstream	std::basic_osyncstream<wchar_t>

成員型別

成員型別	定義
char_type	CharT
traits_type	Traits；如果 Traits::char_type 不是 CharT，則程式格式錯誤。
int_type	Traits::int_type
pos_type	Traits::pos_type
off_type	Traits::off_type
allocator_type	Allocator
streambuf_type	std::basic_streambuf<CharT, Traits>
syncbuf_type	std::basic_syncbuf<CharT, Traits, Allocator>

成員函式

(建構函式)	構造一個 basic_osyncstream 物件 (public member function)
operator=	賦值一個 basic_osyncstream 物件 (public member function)
(解構函式)	銷燬 basic_osyncstream 併發出其內部緩衝區 (public member function)
rdbuf	獲取指向底層 basic_syncbuf 的指標 (public member function)
get_wrapped	獲取指向最終目標流緩衝區的指標 (public member function)
emit	呼叫底層 basic_syncbuf 上的 emit() 以將其內部資料傳輸到最終目標 (public member function)

繼承自 std::basic_ostream

成員函式

格式化輸出
operator<<	插入格式化資料 (std::basic_ostream<CharT,Traits> 的公共成員函式)
非格式化輸出
put	插入一個字元 (std::basic_ostream<CharT,Traits> 的公共成員函式)
write	插入字元塊 (std::basic_ostream<CharT,Traits> 的公共成員函式)
定位
tellp	返回輸出位置指示器 (std::basic_ostream<CharT,Traits> 的公共成員函式)
seekp	設定輸出位置指示器 (std::basic_ostream<CharT,Traits> 的公共成員函式)
雜項
flush	與底層儲存裝置同步 (std::basic_ostream<CharT,Traits> 的公共成員函式)

成員類

sentry

實現流為輸出操作準備的基本邏輯 (std::basic_ostream<CharT,Traits> 的公共成員類)

繼承自 std::basic_ios

成員型別

成員型別	定義
char_type	CharT
traits_type	特性
int_type	Traits::int_type
pos_type	Traits::pos_type
off_type	Traits::off_type

成員函式

狀態函式
good	檢查是否沒有發生錯誤，即 I/O 操作可用 (std::basic_ios<CharT,Traits> 的公共成員函式)
eof	檢查是否已到達檔案末尾 (std::basic_ios<CharT,Traits> 的公共成員函式)
fail	檢查是否發生錯誤 (std::basic_ios<CharT,Traits> 的公共成員函式)
bad	檢查是否發生不可恢復的錯誤 (std::basic_ios<CharT,Traits> 的公共成員函式)
operator!	檢查是否發生錯誤（fail() 的同義詞） (std::basic_ios<CharT,Traits> 的公共成員函式)
operator bool	檢查是否沒有發生錯誤（!fail() 的同義詞） (std::basic_ios<CharT,Traits> 的公共成員函式)
rdstate	返回狀態標誌 (std::basic_ios<CharT,Traits> 的公共成員函式)
setstate	設定狀態標誌 (std::basic_ios<CharT,Traits> 的公共成員函式)
clear	修改狀態標誌 (std::basic_ios<CharT,Traits> 的公共成員函式)
格式化
copyfmt	複製格式化資訊 (std::basic_ios<CharT,Traits> 的公共成員函式)
fill	管理填充字元 (std::basic_ios<CharT,Traits> 的公共成員函式)
雜項
exceptions	管理異常掩碼 (std::basic_ios<CharT,Traits> 的公共成員函式)
imbue	設定區域設定 (std::basic_ios<CharT,Traits> 的公共成員函式)
rdbuf	管理關聯的流緩衝區 (std::basic_ios<CharT,Traits> 的公共成員函式)
tie	管理繫結的流 (std::basic_ios<CharT,Traits> 的公共成員函式)
narrow	窄化字元 (std::basic_ios<CharT,Traits> 的公共成員函式)
widen	寬化字元 (std::basic_ios<CharT,Traits> 的公共成員函式)

繼承自 std::ios_base

成員函式

格式化
flags	管理格式標誌 (std::ios_base 的公共成員函式)
setf	設定特定格式標誌 (std::ios_base 的公共成員函式)
unsetf	清除特定格式標誌 (std::ios_base 的公共成員函式)
precision	管理浮點運算的十進位制精度 (std::ios_base 的公共成員函式)
width	管理欄位寬度 (std::ios_base 的公共成員函式)
區域設定
imbue	設定區域設定 (std::ios_base 的公共成員函式)
getloc	返回當前區域設定 (std::ios_base 的公共成員函式)
內部可擴充套件陣列
xalloc [靜態]	返回一個程式範圍內的唯一整數，可安全用作 pword() 和 iword() 的索引 (std::ios_base 的公共靜態成員函式)
iword	如有必要，調整私有儲存的大小，並訪問給定索引處的 long 元素 (std::ios_base 的公共成員函式)
pword	如有必要，調整私有儲存的大小，並訪問給定索引處的 void* 元素 (std::ios_base 的公共成員函式)
雜項
register_callback	註冊事件回撥函式 (std::ios_base 的公共成員函式)
sync_with_stdio [靜態]	設定 C++ 和 C I/O 庫是否可互操作 (std::ios_base 的公共靜態成員函式)
成員類
failure	流異常 (std::ios_base 的公共成員類)
Init	初始化標準流物件 (std::ios_base 的公共成員類)

成員型別和常量
型別	解釋
openmode	流開啟模式型別 還定義了以下常量 常數 解釋 app 每次寫入前定位到流末尾 二進位制 以二進位制模式開啟 in 為讀取開啟 out 為寫入開啟 trunc 開啟時清空流內容 ate 開啟後立即定位到流末尾 noreplace (C++23) 以獨佔模式開啟 (typedef)
fmtflags	格式化標誌型別 還定義了以下常量 常數 解釋 dec 整數 I/O 使用十進位制基數：見 std::dec oct 整數 I/O 使用八進位制基數：見 std::oct hex 整數 I/O 使用十六進位制基數：見 std::hex basefield dec | oct | hex。用於掩碼操作 left 左對齊（在右側新增填充字元）：見 std::left right 右對齊（在左側新增填充字元）：見 std::right internal 內部對齊（在內部指定點新增填充字元）：見 std::internal adjustfield left | right | internal。用於掩碼操作 scientific 使用科學計數法生成浮點型別，如果與 fixed 結合則使用十六進位制計數法：見 std::scientific fixed 使用定點計數法生成浮點型別，如果與 scientific 結合則使用十六進位制計數法：見 std::fixed floatfield scientific | fixed。用於掩碼操作 boolalpha 以字母數字格式插入和提取 bool 型別：見 std::boolalpha showbase 為整數輸出生成表示數字基數的（字首），在貨幣 I/O 中需要貨幣指示符：見 std::showbase showpoint 無條件地為浮點數輸出生成一個小數點字元：見 std::showpoint showpos 為非負數字輸出生成一個 + 字元：見 std::showpos skipws 在某些輸入操作之前跳過前導空白符：見 std::skipws unitbuf 每次輸出操作後重新整理輸出：見 std::unitbuf uppercase 在某些輸出操作中用大寫等價字元替換某些小寫字母：見 std::uppercase (typedef)
iostate	流狀態型別 還定義了以下常量 常數 解釋 goodbit 無錯誤 badbit 不可恢復的流錯誤 failbit 輸入/輸出操作失敗（格式化或提取錯誤） eofbit 相關聯的輸入序列已到達檔案末尾 (typedef)
seekdir	定位方向型別 還定義了以下常量 常數 解釋 beg 流的起始位置 end 流的結束位置 cur 流位置指示器的當前位置 (typedef)
event	指定事件型別 (enum)
event_callback	回撥函式型別 (typedef)

註釋

特性測試宏	值	標準	特性
__cpp_lib_syncbuf	201803L	(C++20)	同步緩衝輸出流（std::osyncstream，std::syncbuf）和操縱符