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

== Synopsis

Declared in `<bslstp_hashtable.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class _Val,
    class _Traits,
    class _Key,
    class _HF,
    class _ExK,
    class _EqK,
    class _All>
struct _Ht_iterator
    : xref:bsl/_Hashtable_iterator.adoc[_Hashtable_iterator<_Val, _Key, _HF, _ExK, _EqK, _All>]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/_Hashtable_iterator.adoc[_Hashtable_iterator<_Val, _Key, _HF, _ExK, _EqK, _All>]`
| 
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/_Ht_iterator/_Base.adoc[`_Base`] 
| Base iterator type.
| xref:bsl/_Ht_iterator/_Hashtable.adoc[`_Hashtable`] 
| Underlying hash table type for this iterator.
| xref:bsl/_Ht_iterator/_Node.adoc[`_Node`] 
| Node type stored in the underlying hash table.
| xref:bsl/_Ht_iterator/_Self.adoc[`_Self`] 
| This iterator type.
| xref:bsl/_Ht_iterator/iterator_category.adoc[`iterator_category`] 
| `forward_iterator_tag` for this iterator type.
| xref:bsl/_Ht_iterator/pointer.adoc[`pointer`] 
| Pointer type for iterator dereference.
| xref:bsl/_Ht_iterator/reference.adoc[`reference`] 
| Reference type for iterator dereference.
| xref:bsl/_Ht_iterator/size_type.adoc[`size_type`] 
| Unsigned integral type used for sizes.
| xref:bsl/_Ht_iterator/value_type.adoc[`value_type`] 
| Value type referenced by this iterator.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/_Ht_iterator/2constructor-00c.adoc[`_Ht_iterator`]         [.small]#[constructor]#
| Constructors
| xref:bsl/_Hashtable_iterator/_M_skip_to_next.adoc[`_M_skip_to_next`] 
| Advance this iterator to the next element in the hashtable.
| xref:bsl/_Ht_iterator/operator_star.adoc[`operator*`] 
| Return a reference to the value referenced by this iterator.
| xref:bsl/_Ht_iterator/operator_inc-0d.adoc[`operator++`] 
| Increment operators
| xref:bsl/_Ht_iterator/operator_ptr.adoc[`operator‐>`] 
| Return a pointer to the value referenced by this iterator.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:bsl/_Hashtable_iterator/_M_cur.adoc[`_M_cur`] 
| Current node referenced by this iterator.
| xref:bsl/_Hashtable_iterator/_M_ht.adoc[`_M_ht`] 
| Hashtable that owns the referenced node.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/operator_not_eq-095.adoc[`operator!=`]
| Return `true` if the specified iterators refer to the same node.
| xref:bsl/operator_eq-07.adoc[`operator==`]
| Return `true` if the specified iterators refer to the same node.
|===


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