std::istreambuf_iterator

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

イテレータライブラリ

イテレータのコンセプト
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
イテレータのプリミティブ
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (C++17で非推奨) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
アルゴリズムのコンセプトとユーティリティ
間接呼び出し可能コンセプト
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
共通アルゴリズム要件
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
ユーティリティ
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
イテレータアダプタ
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
ストリームイテレータ istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	イテレータのカスタマイゼーションポイント ranges::iter_move (C++20) ranges::iter_swap (C++20)
イテレータ操作 advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	Rangeアクセス begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (C++17)

 

std::istreambuf_iterator

メンバ関数

istreambuf_iterator::istreambuf_iterator

istreambuf_iterator::operator*

istreambuf_iterator::operator++istreambuf_iterator::operator++(int)

istreambuf_iterator::equal

非メンバ関数

operator==operator!= (C++20まで)

 

ヘッダ <iterator> で定義
template< class CharT, class Traits = std::char_traits<CharT> > class istreambuf_iterator     : public std::iterator<std::input_iterator_tag,                            CharT, typename Traits::off_type,                            /* 不明 */, CharT>		(C++17まで)
template< class CharT, class Traits = std::char_traits<CharT> > class istreambuf_iterator;		(C++17以降)

std::istreambuf_iteratorは、構築されたstd::basic_streambufオブジェクトから連続する文字を読み取る、シングルパス入力イテレータです。

デフォルトコンストラクタで構築されたstd::istreambuf_iteratorは、*ストリーム終了*イテレータとして知られています。std::istreambuf_iteratorが基になるストリームの終わりに達すると、ストリーム終了イテレータと等しくなります。それをさらに逆参照またはインクリメントすると、未定義の動作が発生します。

std::istreambuf_iteratorは、トリビアルなコピーコンストラクタ、constexprのデフォルトコンストラクタ、およびトリビアルなデストラクタを持ちます。

(C++11以降)

メンバ型

メンバ型	定義
iterator_category	std::input_iterator_tag
value_type	CharT
difference_type	typename Traits::off_type
pointer	/* 不明 */
reference	CharT
char_type	CharT
traits_type	Traits
int_type	typename Traits::int_type
streambuf_type	std::basic_streambuf<CharT, Traits>
istream_type	std::basic_istream<CharT, Traits>
/* プロキシ */	実装定義のクラス型。 proxyオブジェクトは、char_type文字とstreambuf_type*ポインタを保持します。 operator*でproxyオブジェクトを逆参照すると、保持されている文字が得られます。 (説明専用メンバ型*)

メンバ型iterator_category、value_type、difference_type、pointer、およびreferenceは、std::iterator<std::input_iterator_tag, CharT, typename Traits::off_type, /* 不明 */, CharT>から継承することによって取得される必要があります。

(C++17まで)

メンバ型pointerは通常CharT*です（以下を参照）。

メンバ関数

(コンストラクタ)	新しいistreambuf_iteratorを構築します (public member function)
(デストラクタ) (暗黙的に宣言)	istreambuf_iteratorを破棄します (public member function)
operator*	現在の文字のコピーを取得します (public member function)
operator++operator++(int)	イテレータを進める (public member function)
equal	両方のistreambuf_iteratorがストリーム終了であるか、または両方が有効であるかをテストします (public member function)

非メンバ関数

operator==operator!= (C++20で削除)

2つのistreambuf_iteratorを比較します (function template)

注記

LWG issue 659の解決により、operator->が導入されました。std::istreambuf_iterator iが与えられた場合、式 (*i).m と i->m は同じ効果を持つと予想されます。

しかし、その解決策は動作の正式な仕様を提供していません。そのため、nullptrを返したり、一時オブジェクトのアドレスを返したり、あるいはメンバを提供しなかったりするなど、実装が異なります。その意図された動作は達成が困難であり、LWG issue 2790の解決により削除されました。

LWG issue 659の解決により、pointerメンバ型は、operator->がプロキシを返すことを可能にするために、不明とされました。これは、CharTがクラス型ではない場合にoperator->がコンパイルできるようにするためです。

例

このコードを実行

#include <iostream>
#include <iterator>
#include <sstream>
#include <string>
 
int main()
{
    // typical use case: an input stream represented as a pair of iterators
    std::istringstream in{"Hello, world"};
    std::istreambuf_iterator<char> it{in}, end;
    std::string ss{it, end};
    std::cout << "ss has " << ss.size() << " bytes; "
                 "it holds \"" << ss << "\"\n";
 
    // demonstration of the single-pass nature
    std::istringstream s{"abc"};
    std::istreambuf_iterator<char> i1{s}, i2{s};
    std::cout << "i1 returns '" << *i1 << "'\n"
                 "i2 returns '" << *i2 << "'\n";
 
    ++i1;
    std::cout << "after incrementing i1, but not i2:\n"
                 "i1 returns '" << *i1 << "'\n"
                 "i2 returns '" << *i2 << "'\n";
 
    ++i2;
    std::cout << "after incrementing i2, but not i1:\n"
                 "i1 returns '" << *i1 << "'\n"
                 "i2 returns '" << *i2 << "'\n";
}

出力

ss has 12 bytes; it holds "Hello, world"
i1 returns 'a'
i2 returns 'a'
after incrementing i1, but not i2:
i1 returns 'b'
i2 returns 'b'
after incrementing i2, but not i1:
i1 returns 'c'
i2 returns 'c'

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 659	C++98	1. std::istreambuf_iteratorにはoperator->がありませんでした。 2. メンバ型pointerはCharT*として指定されていました。	1. 追加された 2. 不明に変更されました。
LWG 2790	C++98	LWG issue 659によって追加されたoperator->は有用ではありませんでした。	削除

関連項目

ostreambuf_iterator	std::basic_streambuf に書き込む出力イテレータ (クラステンプレート)
istream_iterator	std::basic_istream から読み取る入力イテレータ (クラステンプレート)