std::basic_stringbuf

 

C++

編譯器支持

自立實現與有宿主實現

語言

標準庫

標準庫標頭

具名要求

功能特性測試宏 (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_stringbuf

公開成員函數

basic_stringbuf::basic_stringbuf

basic_stringbuf::operator= (C++11)

basic_stringbuf::swap (C++11)

basic_stringbuf::str

basic_stringbuf::get_allocator (C++20)

basic_stringbuf::view (C++20)

受保護成員函數

basic_stringbuf::underflow

basic_stringbuf::pbackfail

basic_stringbuf::overflow

basic_stringbuf::setbuf

basic_stringbuf::seekoff

basic_stringbuf::seekpos

非成員函數

swap(std::basic_stringbuf) (C++11)

僅用於闡述的成員函數

basic_stringbuf::init_buf_ptrs

 

在標頭 <sstream> 定義
template<     class CharT,     class Traits = std::char_traits<CharT>,     class Allocator = std::allocator<CharT> > class basic_stringbuf     : public std::basic_streambuf<CharT, Traits>

std::basic_stringbuf 是關聯字元序列為內存常駐的任意字元序列的 std::basic_streambuf。能從 std::basic_string 的實例初始化它，或將它做成 std::basic_string 的實例。

std::basic_stringbuf 的典型實現保有一個 std::basic_string 類型的對象，或等價的可伸縮序列容器作為數據成員，並將它同時用作受控制字元序列（為 std::basic_streambuf 的六個指針所指向的數組）和關聯字元序列（所有輸入操作的字元源和輸出操作的目標）。

另外，典型的實現保有一個 std::ios_base::openmode 類型的數據成員，以指示流的模式（只讀、只寫、讀寫、尾端寫等）。

如果 overflow() 使用過分配策略，那麼可能會存儲另外的高水位指針，以跟蹤最後初始化的字元。

(C++11 起)

提供了幾個針對常用字元類型的 typedef：

在標頭 <sstream> 定義
類型	定義
std::stringbuf	std::basic_stringbuf<char>
std::wstringbuf	std::basic_stringbuf<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

僅用於闡述的成員

buf	用作底層緩衝區的 std::basic_string<CharT, Traits, Allocator> (僅用於闡述的成員對象*)
mode	關聯流的 std::ios_base::openmode (僅用於闡述的成員對象*)
init_buf_ptrs	初始化輸入和輸出序列 (僅用於闡述的成員函數*)

公開成員函數

(構造函數)	構造一個 basic_stringbuf 對象 (公開成員函數)
operator= (C++11)	賦值 basic_stringbuf 對象 (公開成員函數)
swap (C++11)	交換兩個 basic_stringbuf 對象 (公開成員函數)
(析構函數) [虛] (隱式聲明)	析構 basic_stringbuf 對象和它保有的字元串 (虛公開成員函數)
str	替換或獲得關聯字元串的副本 (公開成員函數)
get_allocator (C++20)	獲得與內部序列容器關聯的分配器的副本 (公開成員函數)
view (C++20)	獲得底層字元序列上的視圖 (公開成員函數)

受保護成員函數

underflow [虛]	返回輸入序列中可用的下一字元 (虛受保護成員函數)
pbackfail [虛]	回放字元到輸入序列中 (虛受保護成員函數)
overflow [虛]	後附字元到輸出序列 (虛受保護成員函數)
setbuf [虛]	試圖以數組替換受控字元序列 (虛受保護成員函數)
seekoff [虛]	用相對定址，重定位輸入序列、輸出序列或兩者中的下一位置指針 (虛受保護成員函數)
seekpos [虛]	用絕對定址，重定位輸入序列、輸出序列或兩者中的下一位置指針 (虛受保護成員函數)

非成員函數

std::swap(std::basic_stringbuf) (C++11)

特化 std::swap 演算法 (函數模板)

繼承自 std::basic_streambuf

成員類型

成員類型	定義
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

成員函數

(析構函數) [虛]	析構 basic_streambuf 對象 (std::basic_streambuf<CharT,Traits> 的虛公開成員函數)
本地環境
pubimbue	改換關聯的本地環境並調用 imbue() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
getloc	獲得關聯的本地環境的副本 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
尋位
pubsetbuf	調用 setbuf() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
pubseekoff	調用 seekoff() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
pubseekpos	調用 seekpos() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
pubsync	調用 sync() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
獲取區
in_avail	獲得獲取區中立即可用的字元數 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
snextc	推進輸入序列，然後讀取一個字元而不再推進 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
sbumpcstossc (C++17 移除)	從輸入序列讀取一個字元並令序列前進 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
sgetc	從輸入序列讀取一個字元，而不推進序列 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
sgetn	調用 xsgetn() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
放置區
sputc	寫一個字元到放置區域，並推進下一位置指針 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
sputn	調用 xsputn() (std::basic_streambuf<CharT,Traits> 的公開成員函數)
回放
sputbackc	在輸入序列中放回一個字元 (std::basic_streambuf<CharT,Traits> 的公開成員函數)
sungetc	回移一位輸出序列中的下一位置指針 (std::basic_streambuf<CharT,Traits> 的公開成員函數)

受保護成員函數

(構造函數)	構造 basic_streambuf 對象 (受保護成員函數)
operator= (C++11)	替換 basic_streambuf 對象 (受保護成員函數)
swap (C++11)	交換兩個 basic_streambuf 對象 (受保護成員函數)
本地環境
imbue [虛]	響應關聯本地環境的更改 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
尋位
setbuf [虛]	（在允許時）以用戶定義數組替換緩衝區 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
seekoff [虛]	用相對定址重定位輸入序列、輸出序列或兩者中的下一位置指針 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
seekpos [虛]	用絕對定址重定位輸入序列、輸出序列或兩者中的下一位置指針 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
sync [虛]	將緩衝與關聯的字元序列同步 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
獲取區
showmanyc [虛]	獲得關聯輸入序列中可用於輸入的字元數（如果已知） (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
underflow [虛]	從關聯輸入序列讀取字元到獲取區 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
uflow [虛]	從輸入序列讀取字元到獲取區，並推進下一位置指針 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
xsgetn [虛]	從輸入序列讀取多個字元 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
ebackgptregptr	返回指向獲取區起始、當前字元和末尾的指針 (受保護成員函數)
gbump	推進輸出序列中的下一位置指針 (受保護成員函數)
setg	重定位輸入序列的起始、下一位置和終止指針 (受保護成員函數)
放置區
xsputn [虛]	將多個字元寫到輸出序列 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
overflow [虛]	從放置區寫入字元到關聯的輸出序列 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)
pbasepptrepptr	返回指向放置區的起始、當前字元和末尾的指針 (受保護成員函數)
pbump	推進輸出序列中的下一位置指針 (受保護成員函數)
setp	重定位輸出序列的起始、下一位置和終止指針 (受保護成員函數)
回放
pbackfail [虛]	將字元放回輸入序列，可能修改輸入序列 (std::basic_streambuf<CharT,Traits> 的虛受保護成員函數)