iterator.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/yaml_config/iterator.hpp
/// @brief @copybrief yaml_config::Iterator
/// @ingroup userver_universal
 
#include <iterator>
 
#include <userver/formats/yaml/value.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace yaml_config {
 
/// @brief Forward iterator adapter over YAML-backed configuration containers.
template <typename IterTraits>
class Iterator final {
public:
    using YamlIterator = formats::yaml::Value::const_iterator;
    using iterator_category = std::forward_iterator_tag;
    using difference_type = std::ptrdiff_t;
    using value_type = typename IterTraits::value_type;
    using reference = typename IterTraits::reference;
    using pointer = typename IterTraits::pointer;
 
    Iterator();
 
    Iterator(const value_type& container, YamlIterator it)
        : container_(&container),
          it_(std::move(it))
    {}
 
    Iterator(const Iterator& other);
    Iterator(Iterator&& other) noexcept;
    Iterator& operator=(const Iterator&);
    Iterator& operator=(Iterator&&) noexcept;
 
    Iterator operator++(int);
    Iterator& operator++();
 
    reference operator*() const {
        UpdateValue();
        return *current_;
    }
    pointer operator->() const {
        UpdateValue();
        return &(*current_);
    }
 
    /// Return whether this is iterator over object or over array
    /// @returns formats::common::kArray or formats::common::kObject
    formats::common::Type GetIteratorType() const { return it_.GetIteratorType(); }
 
    // Get member name - only if iterator is over object
    std::string GetName() const;
 
    bool operator==(const Iterator& other) const { return it_ == other.it_; }
    bool operator!=(const Iterator& other) const { return it_ != other.it_; }
 
private:
    void UpdateValue() const;
    void IncrementInternalIterator();
 
    // Pointer to the 'container' yaml - because substitution parsing
    // only works with container[index/key] statements
    const value_type* container_{nullptr};
    // Iterator over container. We actually only use its GetIndex/GetName
    // members
    YamlIterator it_;
    mutable std::optional<value_type> current_;
};
 
}  // namespace yaml_config
 
USERVER_NAMESPACE_END