Class header_field_iterator

include/tscpp/api/Headers.h:177–236

* @brief A header field iterator is an iterator that dereferences to a HeaderField. */

 * @brief A header field iterator is an iterator that dereferences to a HeaderField.
 */
class header_field_iterator
{
private:
  HeaderFieldIteratorState *state_;
  header_field_iterator(void *hdr_buf, void *hdr_loc, void *field_loc);

public:
  using iterator_category = std::forward_iterator_tag;
  using value_type        = int;

  ~header_field_iterator();

  /**
   * Copy Constructor for header_field_iterator, this shouldn't need to be used directly.
   * @param header_field_iterator: for constructing the iterator.
   * @warning This shouldn't need to be used directly!
   */
  header_field_iterator(const header_field_iterator &it);

  header_field_iterator &operator=(const header_field_iterator &rhs);

  /**
   * Advance the iterator to the next header field
   * @return a reference to a the next iterator
   */
  header_field_iterator &operator++();

  /**
   * Advance the current iterator to the next header field
   * @return a new iterator which points to the next element
   */
  header_field_iterator operator++(int);

  /**
   * Advance the iterator to the next header field with the same name
   * @return a reference to a the next iterator
   */
  header_field_iterator &nextDup();

  /**
   * Comparison operator, compare two iterators
   * @return true if the two iterators point to the same HeaderField
   */
  bool operator==(const header_field_iterator &rhs) const;

  /**
   * Inequality Operator, compare two iterators
   * @return false if the two iterators are the same.
   */
  bool operator!=(const header_field_iterator &rhs) const;

  /**
   * Dereference an iterator
   * @return a HeaderField pointed to by this iterator
   */
  HeaderField operator*();

  friend class HeaderField;