Class header_field_value_iterator

include/tscpp/api/Headers.h:114–172

* @brief A header field value iterator iterates through all header fields. */

 * @brief A header field value iterator iterates through all header fields.
 */
class header_field_value_iterator
{
private:
  HeaderFieldValueIteratorState *state_;

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

  /**
   * Constructor for header_field_value_iterator, this shouldn't need to be used directly.
   * @param bufp the TSMBuffer associated with the headers
   * @param mloc the TSMLoc associated with the headers.
   * @param field_loc the TSMLoc associated with the field.
   * @param index the index of the value in the HeaderField
   * @warning This shouldn't need to be used directly!
   */
  header_field_value_iterator(void *bufp, void *hdr_loc, void *field_loc, int index);

  /**
   * Copy Constructor for header_field_value_iterator, this shouldn't need to be used directly.
   * @param header_field_value_iterator an existing iterator to copy
   * @warning This shouldn't need to be used directly!
   */
  header_field_value_iterator(const header_field_value_iterator &it);
  ~header_field_value_iterator();

  /**
   * Dereference this iterator into a string (get the value pointed to by this iterator)
   * @return a string which is the value pointed to by this iterator
   */
  std::string operator*();

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

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

  /**
   * Compare two iterators returning true if they are equal
   * @return true if two iterators are equal
   */
  bool operator==(const header_field_value_iterator &rhs) const;

  /**
   * Compare two iterators returning true if they are NOT equal
   * @return true if two iterators are not equal.
   */
  bool operator!=(const header_field_value_iterator &rhs) const;

  friend class HeaderField;