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

Standard&hyphen;conforming forward iterator over a single hash&hyphen;table bucket&period;

== Synopsis

Declared in `&lt;bslstl&lowbar;hashtablebucketiterator&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class VALUE&lowbar;TYPE,
    class DIFFERENCE&lowbar;TYPE&gt;
class HashTableBucketIterator;
----

== Description

This class template implements an in&hyphen;core value&hyphen;semantic type that is an standard&hyphen;conforming forward iterator (see section 24&period;2&period;5 &lsqb;forward&period;iterators&rsqb;of the C&plus;&plus;11 standard) over a list of `bslalg&colon;&colon;BidirectionalLink` objects referred to by a single `bslalg&colon;&colon;HashTableBucket` object&period; A `HashTableBucketIterator` object provides access to values of the (template parameter) `VALUE&lowbar;TYPE`, stored in a bucket of a hash table&period; The (template parameter) `DIFFERENCE&lowbar;TYPE` determines the standard mandated `difference&lowbar;type` of the iterator, without requiring access to the allocator&hyphen;traits for the node&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/HashTableBucketIterator/difference_type.adoc[`difference&lowbar;type`] 
| This `typedef` is an alias to `DIFFERENCE&lowbar;TYPE`&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/iterator_category.adoc[`iterator&lowbar;category`] 
| Standard iterator defined types &lsqb;24&period;4&period;2&rsqb;&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/pointer.adoc[`pointer`] 
| This `typedef` is an alias to `VALUE&lowbar;TYPE &ast;`&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/reference.adoc[`reference`] 
| Reference type for the iterator&apos;s value type&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/value_type.adoc[`value&lowbar;type`] 
| This `typedef` is an alias for the iterator&apos;s value type&period;
|===


== 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&equals;`] 
| Copy the value of the specified `rhs` to this iterator&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/bucket.adoc[`bucket`] 
| Return the address of the hash table bucket referred to by this iterator&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/node.adoc[`node`] 
| Return the address of the node at which this iterator is positioned&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_star.adoc[`operator&ast;`] 
| Return a reference to the element at which this iterator is positioned&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_inc.adoc[`operator&plus;&plus;`] 
| Move this iterator to the next element in the hash table bucket&period;
| xref:BloombergLP/bslstl/HashTableBucketIterator/operator_ptr.adoc[`operator&hyphen;&gt;`] 
| Return the address of the element at which this iterator is positioned&period;
|===


== Non-Member Functions

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


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