std:: ostreambuf_iterator

From cppreference.com

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)

Iterator primitives

input_iterator_tag output_iterator_tag forward_iterator_tag bidirectional_iterator_tag random_access_iterator_tag contiguous_iterator_tag

(C++20)

iter_value_t iter_difference_t iter_reference_t iter_const_reference_t iter_rvalue_reference_t iter_common_reference_t

(C++20) (C++20) (C++20) (C++23) (C++20) (C++20)

iterator (deprecated in C++17)
iterator_traits
incrementable_traits (C++20)
indirectly_readable_traits (C++20)

Algorithm concepts and utilities

Indirect callable concepts

indirectly_unary_invocable indirectly_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)

Common algorithm requirements

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)

Utilities

indirect_result_t

(C++20)

projected

(C++20)

projected_value_t

(C++26)

Iterator adaptors

reverse_iterator
make_reverse_iterator (C++14)
move_iterator (C++11)
make_move_iterator (C++11)
default_sentinel_t default_sentinel (C++20) (C++20)
unreachable_sentinel_t unreachable_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)

Stream iterators

istream_iterator
ostream_iterator

istreambuf_iterator
ostreambuf_iterator

Iterator customization points
ranges::iter_move (C++20)
ranges::iter_swap (C++20)

Iterator operations

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 access

begin cbegin (C++11) (C++14)
rbegin crbegin (C++14) (C++14)

end cend (C++11) (C++14)
rend crend (C++14) (C++14)

size ssize (C++17) (C++20)
empty (C++17)
data (C++17)

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 LegacyOutputIterator 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 end of file condition has been reached.

Member types

Member type Definition

iterator_category std:: output_iterator_tag

value_type void


          difference_type

void	(until C++20)
std::ptrdiff_t	(since C++20)

pointer void

reference void

char_type CharT

traits_type Traits

streambuf_type std:: basic_streambuf < CharT, Traits >

ostream_type std:: basic_ostream < CharT, Traits >

Member types iterator_category , value_type , difference_type , pointer and reference are required to be obtained by inheriting from std:: iterator < std:: output_iterator_tag , void , void , void , void > .

(until C++17)

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)

Example

Run this code

#include <algorithm>
#include <iostream>
#include <iterator>
#include <string>
 
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

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Metaprogramming library (C++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (C++17)
Regular expressions library (C++11)
Concurrency support library (C++11)
Execution support library (C++26)
Technical specifications
Symbols index
External libraries

Member functions
ostreambuf_iterator::ostreambuf_iterator
ostreambuf_iterator::operator=
ostreambuf_iterator::operator*
ostreambuf_iterator::operator++ ostreambuf_iterator::operator++(int)
ostreambuf_iterator::failed

std:: ostreambuf_iterator

Member types

Member functions

Example

See also

Navigation

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