std::basic_osyncstream

< cpp‎ | io
 
C++
 
输入/输出库
I/O 操纵符
C 风格 I/O
缓冲
(C++98 中弃用)
(C++20)
流
抽象
文件 I/O
字符串 I/O
数组 I/O
(C++98 中弃用)
(C++98 中弃用)
(C++98 中弃用)
同步的输出
basic_osyncstream
(C++20)
类型
错误类别接口
(C++11)
(C++11)
 
std::basic_osyncstream
 
定义于头文件 <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 sync_out(std::cout); // std::cout 的同步包装
    sync_out << "Hello, ";
    sync_out << "World!";
    sync_out << std::endl; // 注意有冲入，但仍未进行
    sync_out << "and more!\n";
} // 转移字符并冲入 std::cout

还有临时量： 

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

它提供保证：所有对最终目标缓冲（上例中为 std::cout ）作出的输出将免除数据竞争，而且将不以任何方式穿插或截断，只要每次对该最终目标缓冲的写入都通过 std::basic_osyncstream （可以不同的）实例进行。

std::basic_osyncstream 的典型实现仅保有一个数据成员：被包装的 std::basic_syncbuf 。

亦定义二个对常用字符类型的特化：

定义于头文件 <syncstream>
 
类型 定义
osyncstream basic_osyncstream<char>
wosyncstream 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
(公开成员函数)
赋值 basic_osyncstream
(公开成员函数)
销毁 basic_osyncstream 并发射其内部缓冲区
(公开成员函数)
获得指向底层 basic_syncbuf 的指针
(公开成员函数)
获得指向最终目标流缓冲的指针
(公开成员函数)
调用底层 basic_syncbuf 上的 emit 以传输其内部数据到最终目标
(公开成员函数)

继承自 std::basic_ostream

成员函数

有格式输出
插入带格式数据
(std::basic_ostream<CharT,Traits> 的公开成员函数)
无格式输出
插入字符
(std::basic_ostream<CharT,Traits> 的公开成员函数)
插入字符块
(std::basic_ostream<CharT,Traits> 的公开成员函数)
寻位
返回输出位置指示器
(std::basic_ostream<CharT,Traits> 的公开成员函数)
设置输出位置指示器
(std::basic_ostream<CharT,Traits> 的公开成员函数)
杂项
与底层存储设备同步
(std::basic_ostream<CharT,Traits> 的公开成员函数)

成员类

 为输出操作实现流准备的基本逻辑
(std::basic_ostream<CharT,Traits> 的公开成员类)

继承自 std::basic_ios

成员类型

 
成员类型 定义
char_type CharT
traits_type Traits
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type

成员函数

状态函数
检查是否没有发生错误，例如是否可执行I/O操作
(std::basic_ios<CharT,Traits> 的公开成员函数)
检查是否到达了文件末尾
(std::basic_ios<CharT,Traits> 的公开成员函数)
检查是否发生了可恢复的错误
(std::basic_ios<CharT,Traits> 的公开成员函数)
检查是否已发生不可恢复的错误
(std::basic_ios<CharT,Traits> 的公开成员函数)
检查是否有错误发生（fail() 的同义词）
(std::basic_ios<CharT,Traits> 的公开成员函数)
(C++11 前)(C++11 起)
 检查是否没有发生错误（!fail()的同义词）
(std::basic_ios<CharT,Traits> 的公开成员函数)
返回状态标志
(std::basic_ios<CharT,Traits> 的公开成员函数)
设置状态标志
(std::basic_ios<CharT,Traits> 的公开成员函数)
修改状态标志
(std::basic_ios<CharT,Traits> 的公开成员函数)
格式化
复制格式化信息
(std::basic_ios<CharT,Traits> 的公开成员函数)
管理填充字符
(std::basic_ios<CharT,Traits> 的公开成员函数)
杂项
管理异常掩码
(std::basic_ios<CharT,Traits> 的公开成员函数)
设置本地环境
(std::basic_ios<CharT,Traits> 的公开成员函数)
管理相关的流缓冲区
(std::basic_ios<CharT,Traits> 的公开成员函数)
管理绑定的流
(std::basic_ios<CharT,Traits> 的公开成员函数)
窄化字符
(std::basic_ios<CharT,Traits> 的公开成员函数)
拓宽字符
(std::basic_ios<CharT,Traits> 的公开成员函数)

继承自 std::ios_base

成员函数

格式化
管理格式标志
(std::ios_base 的公开成员函数)
设置特定格式标志
(std::ios_base 的公开成员函数)
清除特定格式的标志
(std::ios_base 的公开成员函数)
管理浮点操作的精度
(std::ios_base 的公开成员函数)
管理域的宽度
(std::ios_base 的公开成员函数)
本地环境
设置本地环境
(std::ios_base 的公开成员函数)
返回当前本地环境
(std::ios_base 的公开成员函数)
内部可扩展数组
[静态]
 返回能安全用作 pword() 和 iword() 下标的程序范围内独有的整数
(std::ios_base 的公开静态成员函数)
如果有必要的话，调整私有存储的大小，并且访问位于提供的下标的long元素
(std::ios_base 的公开成员函数)
若需要则重置私有存储的大小，并访问位于指定下标的 void* 元素
(std::ios_base 的公开成员函数)
杂项
注册事件回调函数
(std::ios_base 的公开成员函数)
[静态]
 设置C++和C的IO库是否可以互操作
(std::ios_base 的公开静态成员函数)
成员类
流异常
(std::ios_base 的公开成员类)
初始化标准流对象
(std::ios_base 的公开成员类)

成员类型和常量

 
类型 解释
流打开模式类型

亦定义下列常量：

 
常量 解释
app 每次写入前寻位到流结尾
binary 以二进制模式打开
in 为读打开
out 为写打开
trunc 在打开时舍弃流的内容
ate 打开后立即寻位到流结尾

(typedef)
格式化标志类型

亦定义下列常量：

 
常量 解释
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)
流状态类型

亦定义下列常量：

 
常量 解释
goodbit 无错误
badbit 不可恢复的流错误
failbit 输入/输出操作失败（格式化或提取错误）
eofbit 关联的输出序列已抵达文件尾

(typedef)
寻位方向类型

亦定义下列常量：

 
常量 解释
beg 流的开始
end 流的结尾
cur 流位置指示器的当前位置

(typedef)
指定事件类型
(枚举)
回调函数类型
(typedef)