std::ostreambuf_iterator

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

Iterator library

Iterator primitives
iterator_traits
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tag
iterator
Iterator adaptors
reverse_iterator move_iterator (C++11) back_insert_iterator front_insert_iterator insert_iterator	make_reverse_iterator (C++14) make_move_iterator (C++11) back_inserter front_inserter inserter
Stream iterators
istream_iterator
ostream_iterator
istreambuf_iterator
ostreambuf_iterator
Iterator operations
advance
distance
prev (C++11)
next (C++11)
Range access
begincbegin (C++11)(C++14)
endcend (C++11)(C++14)
rbegincrbegin (C++14)(C++14)
rendcrend (C++14)(C++14)
Container access
size (C++17)
empty (C++17)
data (C++17)

std::ostreambuf_iterator

Member functions

ostreambuf_iterator::ostreambuf_iterator

ostreambuf_iterator::operator=

ostreambuf_iterator::operator*

ostreambuf_iterator::operator++ostreambuf_iterator::operator++(int)

ostreambuf_iterator::failed

Defined in header <iterator>
template< class CharT, class Traits = std::char_traits<CharT> > class ostreambuf_iterator : public std::iterator<std::output_iterator_tag, void, void, void, void>		(until C++17)
template< class CharT, class Traits = std::char_traits<CharT> > class ostreambuf_iterator;		(since C++17)

std::ostreambuf_iterator is a single-pass OutputIterator that writes successive characters into the std::basic_streambuf object for which it was constructed. The actual write operation is performed when the iterator (whether dereferenced or not) is assigned to. Incrementing the std::ostreambuf_iterator is a no-op.

In a typical implementation, the only data members of std::ostreambuf_iterator are a pointer to the associated std::basic_streambuf and a boolean flag indicating if the the end of file condition has been reached.

Member types

Member type	Definition
char_type	CharT
traits_type	Traits
streambuf_type	std::basic_streambuf<CharT, Traits>
ostream_type	std::basic_ostream<CharT, Traits>

Member functions

(constructor)	constructs a new ostreambuf_iterator (public member function)
(destructor) (implicitly declared)	destructs an ostreambuf_iterator (public member function)
operator=	writes a character to the associated output sequence (public member function)
operator*	no-op (public member function)
operator++operator++(int)	no-op (public member function)
failed	tests if output failed (public member function)

Member types

Member type	Definition
value_type	void
difference_type	void
pointer	void
reference	void
iterator_category	std::output_iterator_tag

These member types are required to be obtained by inheriting from std::iterator<std::output_iterator_tag,void,void,void,void>.

(until C++17)

Example

Run this code

#include <string>
#include <algorithm>
#include <iterator>
#include <iostream>

int main()
{
    std::string s = "This is an example\n";
    std::copy(s.begin(), s.end(), std::ostreambuf_iterator<char>(std::cout));
}

Output:

This is an example

See also

istreambuf_iterator	input iterator that reads from std::basic_streambuf (class template)
ostream_iterator	output iterator that writes to std::basic_ostream (class template)