命名空间
变体
操作

std::basic_osyncstream

来自 cppreference.com
< cpp‎ | io
 
C++
 
输入/输出库
 
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 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。

cpp/io/ios basecpp/io/basic ioscpp/io/basic ostreamstd-basic osyncstream-inheritance.svg

继承图

为常见的字符类型提供了几个类型定义

定义在头文件 <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 对象
(公有成员函数) [编辑]
 赋值 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> 的公共成员函数) [edit]
 检查是否已到达文件末尾
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 检查是否发生了错误
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 检查是否发生了不可恢复的错误
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 检查是否发生了错误（fail() 的同义词）
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 检查是否没有发生错误（!fail() 的同义词）
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 返回状态标志
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 设置状态标志
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 修改状态标志
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
格式化
 复制格式信息
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 管理填充字符
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
杂项
 管理异常掩码
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 设置区域设置
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 管理关联的流缓冲区
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 管理绑定的流
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 缩小字符
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]
 扩展字符
(std::basic_ios<CharT,Traits> 的公共成员函数) [edit]

从 std::ios_base 继承

成员函数

格式化
 管理格式标志
(std::ios_base 的公共成员函数) [edit]
 设置特定格式标志
(std::ios_base 的公共成员函数) [edit]
 清除特定格式标志
(std::ios_base 的公共成员函数) [edit]
 管理浮点运算的十进制精度
(std::ios_base 的公共成员函数) [edit]
 管理字段宽度
(std::ios_base 的公共成员函数) [edit]
区域设置
 设置区域设置
(std::ios_base 的公共成员函数) [edit]
 返回当前区域设置
(std::ios_base 的公共成员函数) [edit]
内部可扩展数组
[静态]
 返回一个程序范围内的唯一整数，该整数可安全用作 pword() 和 iword() 的索引
(std::ios_base 的公共静态成员函数) [edit]
 如果需要，调整私有存储的大小，并访问给定索引处的 long 元素
(std::ios_base 的公共成员函数) [edit]
 如果需要，调整私有存储的大小，并访问给定索引处的 void* 元素
(std::ios_base 的公共成员函数) [edit]
杂项
 注册事件回调函数
(std::ios_base 的公共成员函数) [edit]
[静态]
 设置 C++ 和 C I/O 库是否可以互操作
(std::ios_base 的公共静态成员函数) [edit]
成员类
 流异常
(std::ios_base 的公共成员类) [edit]
 初始化标准流对象
(std::ios_base 的公共成员类) [edit]

成员类型和常量

类型 说明
 流打开模式类型

还定义了以下常量

常量 说明[edit]
app 每次写入前都定位到流的末尾[edit]
binary 以 二进制模式 打开[edit]
in 以读模式打开[edit]
out 以写模式打开[edit]
trunc 打开时丢弃流的内容[edit]
ate 打开后立即定位到流的末尾[edit]
noreplace (C++23) 以独占模式打开[edit]

(typedef) [edit]
 格式化标志类型

还定义了以下常量

常量 说明[edit]
dec 对整数 I/O 使用十进制基数：参见 std::dec[edit]
oct 对整数 I/O 使用八进制基数：参见 std::oct[edit]
hex 使用十六进制基数进行整数 I/O：参见 std::hex[edit]
基数域 dec | oct | hex。对掩码操作很有用[edit]
左对齐 左对齐（在右侧添加填充字符）：参见 std::left[edit]
右对齐 右对齐（在左侧添加填充字符）：参见 std::right[edit]
内部对齐 内部对齐（在内部指定位置添加填充字符）：参见 std::internal[edit]
对齐域 left | right | internal。对掩码操作很有用[edit]
科学计数法 使用科学计数法生成浮点类型，或与 fixed 结合使用时生成十六进制表示法：参见 std::scientific[edit]
定点计数法 使用定点计数法生成浮点类型，或与 scientific 结合使用时生成十六进制表示法：参见 std::fixed[edit]
浮点域 scientific | fixed。对掩码操作很有用[edit]
boolalpha 以字母数字格式插入和提取 bool 类型：参见 std::boolalpha[edit]
showbase 生成一个前缀，用于指示整数输出的数字基数，在货币 I/O 中需要货币指示符：参见 std::showbase[edit]
showpoint 为浮点数输出始终生成小数点字符：参见 std::showpoint[edit]
showpos 为非负数输出生成 + 字符：参见 std::showpos[edit]
skipws 在某些输入操作之前跳过前导空白：参见 std::skipws[edit]
unitbuf 在每次输出操作后刷新输出：参见 std::unitbuf[edit]
uppercase 将某些小写字母替换为其大写字母
在某些输出操作中的等效项：参见 std::uppercase[edit]

(typedef) [edit]
 流类型的状态

还定义了以下常量

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

(typedef) [edit]
 搜索方向类型

还定义了以下常量

常量 解释[edit]
beg 流的开头[edit]
end 流的结尾[edit]
cur 流位置指示器的当前位置[edit]

(typedef) [edit]
 指定事件类型
(enum) [edit]
 回调函数类型
(typedef) [edit]

[edit] 注释

功能测试 宏 值 Std 功能
__cpp_lib_syncbuf 201803L (C++20) 同步缓冲的 ostream (std::osyncstream, std::syncbuf) 和操作符
从 "https://cppreference.cn/mwiki/index.php?title=cpp/io/basic_osyncstream&oldid=165196" 获取