operator<<(std::basic_ostream)

来自cppreference.com
< cpp‎ | io‎ | basic ostream
定义于头文件 <ostream>
basic_ostream 与字符
(1)
template< class CharT, class Traits>

basic_ostream<CharT,Traits>& operator<<( basic_ostream<CharT,Traits>& os,

                                         CharT ch );
template< class CharT, class Traits>

basic_ostream<CharT,Traits>& operator<<( basic_ostream<CharT,Traits>& os,

                                         char ch );
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        char ch );
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        signed char ch );
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        unsigned char ch );
basic_ostream 与字符数组
(2)
template< class CharT, class Traits >

basic_ostream<CharT,Traits>& operator<<( basic_ostream<CharT,Traits>& os,

                                         const CharT* s );
template< class CharT, class Traits >

basic_ostream<CharT,Traits>& operator<<( basic_ostream<CharT,Traits>& os,

                                         const char* s );
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,  

                                        const char* s );
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        const signed char* s );
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        const unsigned char* s );
basic_ostream 右值
template< class Ostream, class T >

Ostream&&                   operator<<( Ostream&& os,

                                        const T& value );
(3) (C++11 起)
basic_ostream 与 UTF 字符/数组的被删除重载
(4) (C++20 起)
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        wchar_t ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        char8_t ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        char16_t ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        char32_t ch ) = delete;
template< class Traits >

basic_ostream<wchar_t,Traits>& operator<<( basic_ostream<wchar_t,Traits>& os,

                                           char8_t ch ) = delete;
template< class Traits >

basic_ostream<wchar_t,Traits>& operator<<( basic_ostream<wchar_t,Traits>& os,

                                           char16_t ch ) = delete;
template< class Traits >

basic_ostream<wchar_t,Traits>& operator<<( basic_ostream<wchar_t,Traits>& os,

                                           char32_t ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        const wchar_t* ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        const char8_t* ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        const char16_t* ch ) = delete;
template< class Traits >

basic_ostream<char,Traits>& operator<<( basic_ostream<char,Traits>& os,

                                        const char32_t* ch ) = delete;
template< class Traits >

basic_ostream<wchar_t,Traits>& operator<<( basic_ostream<wchar_t,Traits>& os,

                                           const char8_t* ch ) = delete;
template< class Traits >

basic_ostream<wchar_t,Traits>& operator<<( basic_ostream<wchar_t,Traits>& os,

                                           const char16_t* ch ) = delete;
template< class Traits >

basic_ostream<wchar_t,Traits>& operator<<( basic_ostream<wchar_t,Traits>& os,

                                           const char32_t* ch ) = delete;

插入字符或字符串。

1) 表现如有格式输出函数 (FormattedOutputFunction) 。在构造并检查 sentry 对象后,插入字符 ch 。若字符类型不是 CharT ,则它首先以 os.widen(ch) 转换。按下列方式确定填充:若 os.width()>1 ,则添加 os.width()-1os.fill() 的副本到输出字符,以组成输出字符序列。 若 (out.flags()&std::ios_base::adjustfield) == std::ios_base::left ,则填充字符被置于输出字符之后,否则在之前。插入前,调用 os.width(0) 以取消 std::setw 的效果,若它存在。
2) 表现如有格式输出函数 (FormattedOutputFunction) 。在构造并检查 sentry 对象后,插入来自首元素为 s 所指向的字符数组的相继字符。
  • 对于第一和第三重载(其中 CharT 匹配 ch 的类型),准确插入 traits::length(s) 个字符。
  • 对于第二重载,准确插入 std::char_traits<char>::length(s) 个字符。
  • 对于最后二个重载,准确插入 traits::length(reinterpret_cast<const char*>(s)) 个字符。

在插入前,首先,用 os.widen() 加宽所有字符,然后按下列方式确定填充:若要插入的字符数少于 os.width() ,则添加足够数量的 os.fill() 副本到字符序列,以令其长等于 os.width() 。若 (out.flags()&std::ios_base::adjustfield) == std::ios_base::left ,则添加填充字符到输出序列的末尾,否则添加它们到序列之前。 在插入后,调用 width(0) 取消 std::setw 的效果,若它存在。

s 为空指针则行为未定义。
3) 给定到输出流对象的右值引用,调用适当的插入运算符(等价于 os << value )。此重载仅若表达式 os << value 为良构且 Ostream 是公开且无歧义地派生自 std::ios_base 的类类型才参与重载决议。
4) 接受 char16_tchar32_t 的(或其空终止序列的)重载被删除:不允许 std::cout << u'X' 。之前,这些会打印整数或指针值。

参数

os - 要插入数据的输出流
ch - 要插入的字符
s - 指向要插入的字符串的指针

返回值

1-2) os
3) std::move(os)

注解

LWG#1203 前,如 (std::ostringstream() << 1.2).str() 的代码无法编译。

示例

#include <iostream>
#include <fstream>
 
int main()
{
    std::cout << "Hello, world" // const char* 重载
              << '\n';          // char 重载
    std::ofstream("test.txt") << 1.2; // 右值重载
}

输出:

Hello, world

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

DR 应用于 出版时的行为 正确行为
LWG 1203 C++11 右值流的重载返回到基类的左值引用 返回到派生类的右值引用
LWG 2534 C++11 右值流的重载未被制约 已制约

参阅

插入带格式数据
(公开成员函数)
拓宽字符
(std::basic_ios<CharT,Traits> 的公开成员函数)