[#bsl-List_Iterator]
= xref:bsl.adoc[bsl]::List_Iterator
:relfileprefix: ../
:mrdocs:

== Synopsis

Declared in `<bslstl_list.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/List_Iterator/difference_type.adoc[`difference_type`] 
| Signed integral type used for iterator distances.
| xref:bsl/List_Iterator/iterator_category.adoc[`iterator_category`] 
| `bidirectional_iterator_tag` for this iterator type.
| xref:bsl/List_Iterator/pointer.adoc[`pointer`] 
| Pointer to the element type referenced by this iterator.
| xref:bsl/List_Iterator/reference.adoc[`reference`] 
| Reference to the element type referenced by this iterator.
| xref:bsl/List_Iterator/value_type.adoc[`value_type`] 
| Value type referenced by this iterator.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/List_Iterator/2constructor-07.adoc[`List_Iterator`]         [.small]#[constructor]#
| Constructors
| xref:bsl/List_Iterator/2destructor.adoc[`~List_Iterator`] [.small]#[destructor]#
| Default compiler‐generated destructor.
| xref:bsl/List_Iterator/operator_assign.adoc[`operator=`] 
| Default compiler‐generated copy‐assignment operator.
| xref:bsl/List_Iterator/operator_star.adoc[`operator*`] 
| Return a reference providing modifiable access to the element referenced by this iterator. The behavior is undefined unless this iterator is in the range `[begin() .. end())]` for some list (i.e., the iterator is not singular, is not `end()`, and has not been invalidated).
| xref:bsl/List_Iterator/operator_inc-0f.adoc[`operator++`] 
| Increment operators
| xref:bsl/List_Iterator/operator_dec-0b.adoc[`operator‐‐`] 
| Decrement operators
| xref:bsl/List_Iterator/operator_ptr.adoc[`operator‐>`] 
| Return a pointer providing modifiable access to the element referenced by this iterator. The behavior is undefined unless this iterator is in the range `[begin() .. end())]` for some list (i.e., the iterator is not singular, is not `end()`, and has not been invalidated).
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/operator_eq-0da.adoc[bsl::operator==]`
| Return `true` if the specified `lhs` and `rhs` iterators refer to the same list element or both are the `end()` iterator of the same list.
| `bsl::List_Iterator`
| 
| `xref:bsl/list-054.adoc[bsl::list]`
| Forward declaration required by `List_NodeProctor`.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/operator_eq-0e4.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` iterators refer to the same list element or both are the `end()` iterator of the same list.
|===


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