[#BloombergLP-bdlb-FunctionOutputIterator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::FunctionOutputIterator
:relfileprefix: ../../
:mrdocs:

Provide an output iterator that invokes a client‐supplied functor.

== Synopsis

Declared in `<bdlb_functionoutputiterator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class FUNCTION>
class FunctionOutputIterator;
----

== Description

Provide an output iterator that calls an object of the (template parameter) type `FUNCTION`. If `FUNCTION` is a functor, de‐referencing this iterator and assigning to the result (of dereferencing) will call the `operator()` of the functor with the assigned value as a parameter. Similarly, if `FUNCTION` is a function pointer type, assigning to the dereferenced iterator will call the function supplied at construction with the assigned value as a parameter.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/FunctionOutputIterator/difference_type.adoc[`difference_type`] 
| Unused difference type required by `iterator_traits` (always `void`).
| xref:BloombergLP/bdlb/FunctionOutputIterator/iterator_category.adoc[`iterator_category`] 
| Tag identifying this type as an output iterator.
| xref:BloombergLP/bdlb/FunctionOutputIterator/pointer.adoc[`pointer`] 
| Unused pointer type required by `iterator_traits` (always `void`).
| xref:BloombergLP/bdlb/FunctionOutputIterator/reference.adoc[`reference`] 
| Unused reference type required by `iterator_traits` (always `void`).
| xref:BloombergLP/bdlb/FunctionOutputIterator/value_type.adoc[`value_type`] 
| Unused value type required by `iterator_traits` (always `void`).
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/FunctionOutputIterator/2constructor-06.adoc[`FunctionOutputIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlb/FunctionOutputIterator/operator_star.adoc[`operator*`] 
| Return a proxy that invokes the held functor on assignment.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/operator_inc-00.adoc[`operator++`]
| Do nothing and return a copy of the specified `iterator`.
| xref:BloombergLP/bdlb/operator_inc-051.adoc[`operator++`]
| Do nothing and return the specified `iterator`.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#