std::basic_spanbuf

来自cppreference.com
< cpp‎ | io
在标头 <spanstream> 定义
template<

    class CharT,
    class Traits = std::char_traits<CharT>
> class basic_spanbuf

    : public std::basic_streambuf<CharT, Traits>
(C++23 起)

std::basic_spanbuf 是一个关联内存中固定位置的任意字符序列的 std::basic_streambuf,它能从 std::span<CharT> 初始化,并能被用作 std::span<CharT> 的实例。

std::basic_spanbuf 进行固定缓冲区上的输入/输出,因此它在耗尽底层缓冲区时不会尝试获得新的缓冲区。

提供了几个针对常用字符类型的 typedef:

在标头 <spanstream> 定义
类型 定义
std::spanbuf std::basic_spanbuf<char>
std::wspanbuf std::basic_spanbuf<wchar_t>

成员类型

成员类型 定义
char_type CharT
traits_type TraitsTraits::char_type 不是 CharT 时程序非良构。
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type

数据成员

成员名 定义
mod (private) 记录打开模式的 std::ios_base::openmode
(仅用于阐述的成员对象*)
buf (private) 引用底层缓冲区的 std::span<CharT>
(仅用于阐述的成员对象*)

成员函数

公开成员函数
构造 basic_spanbuf 对象
(公开成员函数)
(析构函数)
[虚] (C++23)
销毁 basic_spanbuf 对象
(虚公开成员函数)
(C++23)
赋值 basic_spanbuf 对象
(公开成员函数)
(C++23)
交换两个 basic_spanbuf 对象
(公开成员函数)
(C++23)
根据模式获得或初始化底层缓冲区
(公开成员函数)
受保护成员函数
[虚] (C++23)
试图以数组替换所控制的字符序列
(虚受保护成员函数)
[虚] (C++23)
用相对寻址重定位输入序列、输出序列或两者的下一位置指针
(虚受保护成员函数)
[虚] (C++23)
用绝对寻址重定位输入序列、输出序列或两者的下一位置指针
(虚受保护成员函数)

非成员函数

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

继承自 std::basic_streambuf

成员类型

成员类型 定义
char_type CharT
traits_type TraitsTraits::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> 的虚公开成员函数)
本地环境
调用 imbue()
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
获得关联的本地环境的副本
(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> 的公开成员函数)
获取区
获得获取区中立即可用的字符数
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
推进输入序列,然后读取一个字符而不再推进
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
(C++17 中移除)
从输入序列读取一个字符并令序列前进
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
从输入序列读取一个字符,而不推进序列
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
调用 xsgetn()
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
放置区
写一个字符到放置区域,并推进下一位置指针
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
调用 xsputn()
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
回放
在输入序列中放回一个字符
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
回移一位输出序列中的下一位置指针
(std::basic_streambuf<CharT,Traits> 的公开成员函数)

受保护成员函数

构造 basic_streambuf 对象
(受保护成员函数)
(C++11)
替换 basic_streambuf 对象
(受保护成员函数)
(C++11)
交换两个 basic_streambuf 对象
(受保护成员函数)
本地环境
[虚]
更改关联的本地环境
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
寻位
[虚]
(在允许时)以用户定义数组替换缓冲区
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
用相对寻址重定位输入序列、输出序列或两者中的下一位置指针
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
用绝对寻址重定位输入序列、输出序列或两者中的下一位置指针
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[虚]
将缓冲与关联的字符序列同步
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
获取区
获得关联输入序列中可用于输入的字符数(如果已知)
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
从关联输入序列读取字符到获取区
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[虚]
从输入序列读取字符到获取区,并推进下一位置指针
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[虚]
从输入序列读取多个字符
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
返回指向获取区起始、当前字符和末尾的指针
(受保护成员函数)
推进输出序列中的下一位置指针
(受保护成员函数)
重定位输入序列的起始、下一位置和终止指针
(受保护成员函数)
放置区
[虚]
将多个字符写到输出序列
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
从放置区写入字符到关联的输出序列
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
返回指向放置区的起始、当前字符和末尾的指针
(受保护成员函数)
推进输出序列中的下一位置指针
(受保护成员函数)
重定位输出序列的起始、下一位置和终止指针
(受保护成员函数)
回放
将字符放回输入序列,可能修改输入序列
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)

注解

std::basic_spanbuf 不占有底层缓冲区。

程序员负责在使用 std::basic_spanbuf 时确保它的缓冲区处于它的生存期中。多于一个线程在通过不同的 std::basic_spanbuf 对象操作同一底层缓冲区时可能需要额外的同步。

功能特性测试 标准 功能特性
__cpp_lib_spanstream 202106L (C++23) std::spanbuf, std::spanstream

参阅

实现原生字符串设备
(类模板)
(C++98 中弃用)(C++26 中移除)
实现原生字符数组设备
(类)