[#BloombergLP-bslstl-HashTableBucketIterator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslstl.adoc[bslstl]::HashTableBucketIterator
:relfileprefix: ../../
:mrdocs:

Standard‐conforming forward iterator over a single hash‐table bucket.

== Synopsis

Declared in `<bslstl_hashtablebucketiterator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class VALUE_TYPE,
    class DIFFERENCE_TYPE>
class HashTableBucketIterator;
----

== Description

This class template implements an in‐core value‐semantic type that is an standard‐conforming forward iterator (see section 24.2.5 [forward.iterators]of the C++11 standard) over a list of `bslalg::BidirectionalLink` objects referred to by a single `bslalg::HashTableBucket` object. A `HashTableBucketIterator` object provides access to values of the (template parameter) `VALUE_TYPE`, stored in a bucket of a hash table. The (template parameter) `DIFFERENCE_TYPE` determines the standard mandated `difference_type` of the iterator, without requiring access to the allocator‐traits for the node.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/HashTableBucketIterator/difference_type.adoc[`difference_type`] 
| This `typedef` is an alias to `DIFFERENCE_TYPE`.
| xref:BloombergLP/bslstl/HashTableBucketIterator/iterator_category.adoc[`iterator_category`] 
| Standard iterator defined types [24.4.2].
| xref:BloombergLP/bslstl/HashTableBucketIterator/pointer.adoc[`pointer`] 
| This `typedef` is an alias to `VALUE_TYPE *`.
| xref:BloombergLP/bslstl/HashTableBucketIterator/reference.adoc[`reference`] 
| Reference type for the iterator's value type.
| xref:BloombergLP/bslstl/HashTableBucketIterator/value_type.adoc[`value_type`] 
| This `typedef` is an alias for the iterator's value type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/HashTableBucketIterator/2constructor-0c.adoc[`HashTableBucketIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_assign.adoc[`operator=`] 
| Copy the value of the specified `rhs` to this iterator.
| xref:BloombergLP/bslstl/HashTableBucketIterator/bucket.adoc[`bucket`] 
| Return the address of the hash table bucket referred to by this iterator.
| xref:BloombergLP/bslstl/HashTableBucketIterator/node.adoc[`node`] 
| Return the address of the node at which this iterator is positioned.
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_star.adoc[`operator*`] 
| Return a reference to the element at which this iterator is positioned.
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_inc.adoc[`operator++`] 
| Move this iterator to the next element in the hash table bucket.
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_ptr.adoc[`operator‐>`] 
| Return the address of the element at which this iterator is positioned.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/operator_not_eq-00.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bslstl/operator_not_eq-062ef.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bslstl/operator_not_eq-09f.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bslstl/operator_not_eq-0bf.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bslstl/operator_inc-0d9.adoc[`operator++`]
| Move the specified `iterator` to the next element and return its prior value.
| xref:BloombergLP/bslstl/operator_eq-040.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value.
| xref:BloombergLP/bslstl/operator_eq-04e.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value.
| xref:BloombergLP/bslstl/operator_eq-0b.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value.
| xref:BloombergLP/bslstl/operator_eq-0e.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value.
|===


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