std::codecvt<InternT,ExternT,StateT>::out, std::codecvt<InternT,ExternT,StateT>::do_out
| 在标头 <locale> 定义
|
||
| public: result out( StateT& state, |
(1) | |
| protected: virtual result do_out( StateT& state, |
(2) | |
do_out。codecvt 平面定义一个转换，那么翻译来自源范围 [from, from_end) 的内部字符到外部字符，并将结果置于从 to 开始的相继位置。最多转换 from_end - from 个内部字符，最多写入 to_end - to 个外部字符。令 from_next 和 to_next 指向最后成功转换元素的后一位置。如果此 codecvt 平面不定义转换，那么不会转换字符。设置 to_next 等于 to，不更改 state，并返回 std::codecvt_base::noconv。
如果满足以下条件，do_out(state, from, from + 1, from_next, to, to_end, to_next) 必须返回 ok：
- 此
codecvt平面用于 basic_filebuf，并且 - do_out(state, from, from_end, from_next, to, to_end, to_next) 在 from != from_end 时会返回
ok。
返回值
std::codecvt_base::result 类型值，按以下方式指示成功状况：
ok
|
转换完成 |
partial
|
输出缓冲区的中空间不足，或源缓冲的未期待结尾 |
error
|
遇到无法转换的字符 |
noconv
|
此平面不会转换，不写入输出 |
非转换特化 std::codecvt<char, char, std::mbstate_t> 始终返回 std::codecvt_base::noconv。
注意
要求 from <= from_end && to <= to_end 且 state 要么表示初始迁移状态，要么以转换序列中前趋的字符获得。
尽管 codecvt 支持 N:M 转换（例如 UTF-16 到 UTF-8，其中可能需要两个初始字符决定输出的外部字符）， std::basic_filebuf 只能使用定义 1:N codecvt 转换的平面，即它在写入文件时必须能够一次处理一个内部字符。
进行 N:M 转换时，此函数可能在消耗所有源字符后（from_next == from_end）返回 std::codecvt_base::partial。这表示需要其他内部字符完成转换（例如在转换 UTF-16 到 UTF-8 时，如果源缓冲区中的末字符是高位代理）。
state 上的效果是有意未指定的。标准平面中，它用于维护像是调用 std::wcsrtombs 时的状态，从而被更新为反映最后被处理外部字符后的转换状态，但是用户定义平面可以自由地用它维护任何其他状态，例如计量遇到的特殊字符数。
示例
#include <iostream> #include <string> #include <locale> int main() { std::locale::global(std::locale("en_US.utf8")); auto& f = std::use_facet<std::codecvt<wchar_t, char, std::mbstate_t>>(std::locale()); std::wstring internal = L"z\u00df\u6c34\U0001f34c"; // L"zß水🍌" // 注意 wstring_convert 能做下列内容 std::mbstate_t mb{}; // 初始迁移状态 std::string external(internal.size() * f.max_length(), '\0'); const wchar_t* from_next; char* to_next; f.out(mb, &internal[0], &internal[internal.size()], from_next, &external[0], &external[external.size()], to_next); // 为简洁起见跳过错误检查 external.resize(to_next - &external[0]); std::cout << "在窄多字节编码下的字符串：" << external << '\n'; }
输出：
在窄多字节编码下的字符串：zß水🍌
缺陷报告
下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。
| 缺陷报告 | 应用于 | 出版时的行为 | 正确行为 |
|---|---|---|---|
| LWG 76 | C++98 | 不明确转换是否需要支持每次转换单个内部字符 | 只有用于 basic_filebuf 时才需要 |
参阅
| [虚] |
从放置区写字符到关联的文件 ( std::basic_filebuf<CharT,Traits> 的虚受保护成员函数) |
| 转换宽字符串为字符串 ( std::wstring_convert<Codecvt,Elem,Wide_alloc,Byte_alloc> 的公开成员函数) | |
| 给定状态，转换宽字符串为窄多字节字符串 (函数) | |
| [虚] |
将字符串从 ExternT 转换到 InternT，例如在从文件读取时 (虚受保护成员函数) |