userver: yaml_config::Iterator< iter_traits > Class Template Reference
⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
yaml_config::Iterator< iter_traits > Class Template Referencefinal

Public Types

using YamlIterator = formats::yaml::Value::const_iterator
 
using iterator_category = std::forward_iterator_tag
 
using difference_type = std::ptrdiff_t
 
using value_type = typename iter_traits::value_type
 
using reference = typename iter_traits::reference
 
using pointer = typename iter_traits::pointer
 

Public Member Functions

 Iterator (const value_type &container, YamlIterator it)
 
 Iterator (const Iterator &other)
 
 Iterator (Iterator &&other) noexcept
 
Iteratoroperator= (const Iterator &)
 
Iteratoroperator= (Iterator &&) noexcept
 
Iterator operator++ (int)
 
Iteratoroperator++ ()
 
reference operator* () const
 
pointer operator-> () const
 
formats::common::Type GetIteratorType () const
 
auto GetName () const
 
bool operator== (const Iterator &other) const
 
bool operator!= (const Iterator &other) const
 

Detailed Description

template<typename iter_traits>
class yaml_config::Iterator< iter_traits >

Definition at line 12 of file iterator.hpp.

Member Typedef Documentation

◆ difference_type

template<typename iter_traits >
using yaml_config::Iterator< iter_traits >::difference_type = std::ptrdiff_t

Definition at line 16 of file iterator.hpp.

◆ iterator_category

template<typename iter_traits >
using yaml_config::Iterator< iter_traits >::iterator_category = std::forward_iterator_tag

Definition at line 15 of file iterator.hpp.

◆ pointer

template<typename iter_traits >
using yaml_config::Iterator< iter_traits >::pointer = typename iter_traits::pointer

Definition at line 19 of file iterator.hpp.

◆ reference

template<typename iter_traits >
using yaml_config::Iterator< iter_traits >::reference = typename iter_traits::reference

Definition at line 18 of file iterator.hpp.

◆ value_type

template<typename iter_traits >
using yaml_config::Iterator< iter_traits >::value_type = typename iter_traits::value_type

Definition at line 17 of file iterator.hpp.

◆ YamlIterator

template<typename iter_traits >
using yaml_config::Iterator< iter_traits >::YamlIterator = formats::yaml::Value::const_iterator

Definition at line 14 of file iterator.hpp.

Constructor & Destructor Documentation

◆ Iterator()

template<typename iter_traits >
yaml_config::Iterator< iter_traits >::Iterator ( const value_type &  container,
YamlIterator< iter_traits >  it 
)
inline

Definition at line 21 of file iterator.hpp.

Member Function Documentation

◆ GetIteratorType()

template<typename iter_traits >
formats::common::Type yaml_config::Iterator< iter_traits >::GetIteratorType ( ) const
inline

Return whether this is iterator over object or over array

Returns
formats::common::kArray or formats::common::kObject

Definition at line 49 of file iterator.hpp.

◆ GetName()

template<typename iter_traits >
auto yaml_config::Iterator< iter_traits >::GetName ( ) const
inline

Definition at line 54 of file iterator.hpp.

◆ operator!=()

template<typename iter_traits >
bool yaml_config::Iterator< iter_traits >::operator!= ( const Iterator< iter_traits > &  other) const
inline

Definition at line 57 of file iterator.hpp.

◆ operator*()

template<typename iter_traits >
reference yaml_config::Iterator< iter_traits >::operator* ( ) const
inline

Definition at line 38 of file iterator.hpp.

◆ operator++() [1/2]

template<typename iter_traits >
Iterator & yaml_config::Iterator< iter_traits >::operator++ ( )
inline

Definition at line 33 of file iterator.hpp.

◆ operator++() [2/2]

template<typename iter_traits >
Iterator yaml_config::Iterator< iter_traits >::operator++ ( int  )
inline

Definition at line 29 of file iterator.hpp.

◆ operator->()

template<typename iter_traits >
pointer yaml_config::Iterator< iter_traits >::operator-> ( ) const
inline

Definition at line 42 of file iterator.hpp.

◆ operator==()

template<typename iter_traits >
bool yaml_config::Iterator< iter_traits >::operator== ( const Iterator< iter_traits > &  other) const
inline

Definition at line 56 of file iterator.hpp.


The documentation for this class was generated from the following file: