istreambuf_iterator 类

项目
10/17/2023

类模板 istreambuf_iterator 描述输入迭代器对象，此对象可从输入流缓冲区（通过它存储的对象访问）提取指向 basic_streambuf<CharType, Traits> 的类型指针的字符元素。

语法

template <class CharType class Traits = char_traits <CharType>>
class istreambuf_iterator
: public iterator<input_iterator_tag, CharType, typename Traits ::off_type, CharType*, CharType&>

参数

CharType
一种类型，此类型表示 istreambuf_iterator 的字符类型。

特征
一种类型，此类型表示 istreambuf_iterator 的字符类型。此参数为可选参数，默认值为 char_traits<CharType>。

备注

istreambuf_iterator 类必须满足输入迭代器的需求。

构造或递增带有非 null 存储指针的 istreambuf_iterator 类对象后，此对象将有效尝试从关联的输入流提取和存储 CharType 类型的对象。不过，提取可能会延迟到取消引用对象或复制对象后进行。如果提取失败，对象将使用 null 指针有效替换存储指针，从而设置序列末尾指示符。

构造函数

构造函数	说明
istreambuf_iterator	构造初始化为从输入流读取字符的 `istreambuf_iterator`。

Typedef

类型名称	说明
char_type	为 `ostreambuf_iterator` 的字符类型提供的类型。
int_type	为 `istreambuf_iterator` 提供整数类型的类型。
istream_type	为 `istream_iterator` 的流类型提供的类型。
streambuf_type	为 `istreambuf_iterator` 的流类型提供的类型。
traits_type	为 `istream_iterator` 的字符特征类型提供的类型。

成员函数

成员函数	说明
equal	对于两个输入流缓冲区迭代器是否相等的测试。

运算符

运算符	说明
operator*	取消引用运算符将返回流中的下一字符。
operator++	返回输入流中的下一字符或者在递增对象前复制对象并返回副本。

要求

标头：<iterator>

命名空间： std

istreambuf_iterator::char_type

为 ostreambuf_iterator 的字符类型提供的类型。

typedef CharType char_type;

备注

该类型是模板参数 CharType 的同义词。

示例

// istreambuf_iterator_char_type.cpp
// compile with: /EHsc
#include <iterator>
#include <vector>
#include <iostream>
#include <algorithm>

int main( )
{
   using namespace std;

   typedef istreambuf_iterator<char>::char_type CHT1;
   typedef istreambuf_iterator<char>::traits_type CHTR1;

   cout << "(Try the example: 'So many dots to be done'\n"
        << " then an Enter key to insert into the output,\n"
        << " & use a ctrl-Z Enter key combination to exit): ";

   // istreambuf_iterator for input stream
   istreambuf_iterator< CHT1, CHTR1> charInBuf ( cin );
   ostreambuf_iterator<char> charOut ( cout );

   // Used in conjunction with replace_copy algorithm
   // to insert into output stream and replace spaces
   // with dot-separators
   replace_copy ( charInBuf , istreambuf_iterator<char>( ),
        charOut , ' ' , '.' );
}

istreambuf_iterator::equal

测试：两个输入流缓冲区迭代器是否相等。

bool equal(const istreambuf_iterator<CharType, Traits>& right) const;

参数

right
要针对其检查相等性的迭代器。

返回值

如果这两个 istreambuf_iterator 都是流末尾迭代器，则为 true；如果都不是流末尾迭代器，则为 false。

注解

通过 istreambuf_iterator 定义当前位置和流末尾迭代器的范围，但由于所有非流末尾迭代器在 equal 成员函数下都相等，因此无法使用 istreambuf_iterator 定义任何子范围。 == 和 != 运算符具有相同的语义。

示例

// istreambuf_iterator_equal.cpp
// compile with: /EHsc
#include <iterator>
#include <iostream>

int main( )
{
   using namespace std;

   cout << "(Try the example: 'Hello world!'\n"
        << " then an Enter key to insert into the output,\n"
        << " & use a ctrl-Z Enter key combination to exit): ";

   istreambuf_iterator<char> charReadIn1 ( cin );
   istreambuf_iterator<char> charReadIn2 ( cin );

   bool b1 = charReadIn1.equal ( charReadIn2 );

   if (b1)
      cout << "The iterators are equal." << endl;
   else
      cout << "The iterators are not equal." << endl;
}

istreambuf_iterator::int_type

为 istreambuf_iterator 提供整数类型的类型。

typedef typename traits_type::int_type int_type;

注解

类型是 Traits::int_type 的同义词。

示例

// istreambuf_iterator_int_type.cpp
// compile with: /EHsc
#include <iterator>
#include <iostream>

int main( )
{
   using namespace std;
   istreambuf_iterator<char>::int_type inttype1 = 100;
   cout << "The inttype1 = " << inttype1 << "." << endl;
}
/* Output:
The inttype1 = 100.
*/

istreambuf_iterator::istream_type

为 istreambuf_iterator 的流类型提供的类型。

typedef basic_istream<CharType, Traits> istream_type;

备注

该类型是 basic_istream<CharType, Traits> 的同义词。

示例

有关如何声明和使用 istream_type 的示例，请参阅 istreambuf_iterator。

istreambuf_iterator::istreambuf_iterator

构造一个 istreambuf_iterator，会将其初始化以从输入流读取字符。

istreambuf_iterator(streambuf_type* strbuf = 0) throw();
istreambuf_iterator(istream_type& _Istr) throw();

参数

strbuf
istreambuf_iterator 要附加到的输入流缓冲区。

_Istr
istreambuf_iterator 要附加到的输入流。

备注

第一个构造函数通过 strbuf 初始化输入流缓冲区指针。第二个构造函数通过 _Istr 初始化输入流缓冲区指针。 rdbuf，然后最终尝试提取和存储 CharType 类型的对象。

示例

// istreambuf_iterator_istreambuf_iterator.cpp
// compile with: /EHsc
#include <iterator>
#include <vector>
#include <algorithm>
#include <iostream>

int main( )
{
   using namespace std;

   // Following declarations will not compile:
   istreambuf_iterator<char>::istream_type &istrm = cin;
   istreambuf_iterator<char>::streambuf_type *strmbf = cin.rdbuf( );

   cout << "(Try the example: 'Oh what a world!'\n"
      << " then an Enter key to insert into the output,\n"
      << " & use a ctrl-Z Enter key combination to exit): ";
   istreambuf_iterator<char> charReadIn ( cin );
   ostreambuf_iterator<char> charOut ( cout );

   // Used in conjunction with replace_copy algorithm
   // to insert into output stream and replace spaces
   // with hyphen-separators
   replace_copy ( charReadIn , istreambuf_iterator<char>( ),
      charOut , ' ' , '-' );
}

istreambuf_iterator::operator*

取消引用运算符将返回流中的下一字符。

CharType operator*() const;

返回值

流中的下一个字符。

示例

// istreambuf_iterator_operator_deref.cpp
// compile with: /EHsc
#include <iterator>
#include <iostream>

int main( )
{
   using namespace std;

   cout << "Type string of characters & enter to output it,\n"
      << " with stream buffer iterators,(try: 'I'll be back.')\n"
      << " repeat as many times as desired,\n"
      << " then keystroke ctrl-Z Enter to exit program: ";
   istreambuf_iterator<char> inpos ( cin );
   istreambuf_iterator<char> endpos;
   ostreambuf_iterator<char> outpos ( cout );
   while ( inpos != endpos )
   {
*outpos = *inpos;   //Put value of outpos equal to inpos
      ++inpos;
      ++outpos;
   }
}

istreambuf_iterator::operator++

返回输入流中的下一字符或者在递增对象前复制对象并返回副本。

istreambuf_iterator<CharType, Traits>& operator++();
istreambuf_iterator<CharType, Traits> operator++(int);

返回值

istreambuf_iterator 或对 istreambuf_iterator 的引用。

备注

第一个运算符最终尝试从关联的输入流提取和存储 CharType 类型的对象。第二个运算符生成对象的副本，递增对象，然后返回副本。

示例

// istreambuf_iterator_operator_incr.cpp
// compile with: /EHsc
#include <iterator>
#include <iostream>

int main( )
{
   using namespace std;

   cout << "Type string of characters & enter to output it,\n"
      << " with stream buffer iterators,(try: 'I'll be back.')\n"
      << " repeat as many times as desired,\n"
      << " then keystroke ctrl-Z Enter to exit program: ";
   istreambuf_iterator<char> inpos ( cin );
   istreambuf_iterator<char> endpos;
   ostreambuf_iterator<char> outpos ( cout );
   while ( inpos != endpos )
   {
*outpos = *inpos;
      ++inpos;   //Increment istreambuf_iterator
      ++outpos;
   }
}

istreambuf_iterator::streambuf_type

为 istreambuf_iterator 的流类型提供的类型。

typedef basic_streambuf<CharType, Traits> streambuf_type;

备注

该类型是 basic_streambuf<CharType, Traits> 的同义词。

示例

有关如何声明和使用 istreambuf_type 的示例，请参阅 istreambuf_iterator。

istreambuf_iterator::traits_type

为 istream_iterator 的字符特征类型提供的类型。

typedef Traits traits_type;

注解

该类型是模板参数 Traits 的同义词。

示例

// istreambuf_iterator_traits_type.cpp
// compile with: /EHsc
#include <iterator>
#include <vector>
#include <iostream>
#include <algorithm>

int main( )
{
   using namespace std;

   typedef istreambuf_iterator<char>::char_type CHT1;
   typedef istreambuf_iterator<char>::traits_type CHTR1;

   cout << "(Try the example: 'So many dots to be done'\n"
        << " then an Enter key to insert into the output,\n"
        << " & use a ctrl-Z Enter key combination to exit): ";

   // istreambuf_iterator for input stream
   istreambuf_iterator< CHT1, CHTR1> charInBuf ( cin );
   ostreambuf_iterator<char> charOut ( cout );

   // Used in conjunction with replace_copy algorithm
   // to insert into output stream and replace spaces
   // with dot-separators
   replace_copy ( charInBuf , istreambuf_iterator<char>( ),
        charOut , ' ' , '.' );
}

另请参阅

iterator 结构
 <iterator>
C++ 标准库中的线程安全
 C++ 标准库参考

通过