命名空间
变体
操作

std::basic_osyncstream

来自 cppreference.cn
< 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

继承图

提供了用于常见字符类型的几个 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) [编辑]
 赋值一个 basic_osyncstream 对象
(public member function) [编辑]
 销毁 basic_osyncstream 并发出其内部缓冲区
(public member function) [编辑]
 获取指向底层 basic_syncbuf 的指针
(public member function) [编辑]
 获取指向最终目标流缓冲区的指针
(public member function) [编辑]
 调用底层 basic_syncbuf 上的 emit() 以将其内部数据传输到最终目标
(public member function) [编辑]

继承自 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 特性
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> 的公共成员函数) [编辑]
 检查是否没有发生错误（!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 I/O 库是否可互操作
(std::ios_base 的公共静态成员函数) [编辑]
成员类
 流异常
(std::ios_base 的公共成员类) [编辑]
 初始化标准流对象
(std::ios_base 的公共成员类) [编辑]

成员类型和常量

类型 解释
 流打开模式类型

还定义了以下常量

常数 解释[编辑]
app 每次写入前定位到流末尾[编辑]
二进制 以二进制模式打开[编辑]
in 为读取打开[编辑]
out 为写入打开[编辑]
trunc 打开时清空流内容[编辑]
ate 打开后立即定位到流末尾[编辑]
noreplace (C++23) 以独占模式打开[编辑]

(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) [编辑]
 指定事件类型
(enum) [编辑]
 回调函数类型
(typedef) [编辑]

[编辑] 注释

特性测试宏 值 标准 特性
__cpp_lib_syncbuf 201803L (C++20) 同步缓冲输出流（std::osyncstream，std::syncbuf）和操纵符
取自“https://cppreference.cn/mwiki/index.php?title=cpp/io/basic_osyncstream&oldid=165196”