(Constant) member iterator for a JSON object value More...

#include <document.h>

Public Types
typedef GenericMemberIterator	Iterator
	Iterator type itself.
typedef GenericMemberIterator< true, Encoding, Allocator >	ConstIterator
	Constant iterator type.
typedef GenericMemberIterator< false, Encoding, Allocator >	NonConstIterator
	Non-constant iterator type.

Public Member Functions
stepping
Iterator &	operator++ ()
Iterator &	operator-- ()
Iterator	operator++ (int)
Iterator	operator-- (int)
increment/decrement
Iterator	operator+ (DifferenceType n) const
Iterator	operator- (DifferenceType n) const
Iterator &	operator+= (DifferenceType n)
Iterator &	operator-= (DifferenceType n)
relations
bool	operator== (ConstIterator that) const
bool	operator!= (ConstIterator that) const
bool	operator<= (ConstIterator that) const
bool	operator>= (ConstIterator that) const
bool	operator< (ConstIterator that) const
bool	operator> (ConstIterator that) const

Private Types
typedef GenericMember< Encoding, Allocator >	PlainType
typedef internal::MaybeAddConst< Const, PlainType >::Type	ValueType

Friends
class	GenericValue< Encoding, Allocator >
template<bool, typename, typename>
class	GenericMemberIterator

std::iterator_traits support
typedef ValueType	value_type
typedef ValueType *	pointer
typedef ValueType &	reference
typedef std::ptrdiff_t	difference_type
typedef std::random_access_iterator_tag	iterator_category
typedef pointer	Pointer
	Pointer to (const) GenericMember.
typedef reference	Reference
	Reference to (const) GenericMember.
typedef difference_type	DifferenceType
	Signed integer type (e.g. `ptrdiff_t`).
	GenericMemberIterator ()
	Default constructor (singular value).
	GenericMemberIterator (const NonConstIterator &it)
	Iterator conversions to more const.
Iterator &	operator= (const NonConstIterator &it)

dereference
Pointer	ptr_
	raw pointer
Reference	operator* () const
Pointer	operator-> () const
Reference	operator[] (DifferenceType n) const
DifferenceType	operator- (ConstIterator that) const
	Distance.
	GenericMemberIterator (Pointer p)
	Internal constructor from plain pointer.

Detailed Description

template<bool Const, typename Encoding, typename Allocator>
class GenericMemberIterator< Const, Encoding, Allocator >

(Constant) member iterator for a JSON object value

Template Parameters

Const	Is this a constant iterator?
Encoding	Encoding of the value. (Even non-string values need to have the same encoding in a document)
Allocator	Allocator type for allocating memory of object, array and string.

This class implements a Random Access Iterator for GenericMember elements of a GenericValue, see ISO/IEC 14882:2003(E) C++ standard, 24.1 [lib.iterator.requirements].

Note: This iterator implementation is mainly intended to avoid implicit conversions from iterator values to NULL, e.g. from GenericValue::FindMember.; Define RAPIDJSON_NOMEMBERITERATORCLASS to fall back to a pointer-based implementation, if your platform doesn't provide the C++ <iterator> header.

See also: GenericMember, GenericValue::MemberIterator, GenericValue::ConstMemberIterator

Member Typedef Documentation

◆ ConstIterator

template<bool Const, typename Encoding, typename Allocator>

typedef GenericMemberIterator<true,Encoding,Allocator> GenericMemberIterator< Const, Encoding, Allocator >::ConstIterator

Constant iterator type.

◆ difference_type

template<bool Const, typename Encoding, typename Allocator>

typedef std::ptrdiff_t GenericMemberIterator< Const, Encoding, Allocator >::difference_type

◆ DifferenceType

template<bool Const, typename Encoding, typename Allocator>

typedef difference_type GenericMemberIterator< Const, Encoding, Allocator >::DifferenceType

Signed integer type (e.g. ptrdiff_t).

◆ Iterator

template<bool Const, typename Encoding, typename Allocator>

typedef GenericMemberIterator GenericMemberIterator< Const, Encoding, Allocator >::Iterator

Iterator type itself.

◆ iterator_category

template<bool Const, typename Encoding, typename Allocator>

typedef std::random_access_iterator_tag GenericMemberIterator< Const, Encoding, Allocator >::iterator_category

◆ NonConstIterator

template<bool Const, typename Encoding, typename Allocator>

typedef GenericMemberIterator<false,Encoding,Allocator> GenericMemberIterator< Const, Encoding, Allocator >::NonConstIterator

Non-constant iterator type.

◆ PlainType

template<bool Const, typename Encoding, typename Allocator>

typedef GenericMember<Encoding,Allocator> GenericMemberIterator< Const, Encoding, Allocator >::PlainType

private

◆ Pointer

template<bool Const, typename Encoding, typename Allocator>

typedef pointer GenericMemberIterator< Const, Encoding, Allocator >::Pointer

Pointer to (const) GenericMember.

◆ pointer

template<bool Const, typename Encoding, typename Allocator>

typedef ValueType* GenericMemberIterator< Const, Encoding, Allocator >::pointer

◆ Reference

template<bool Const, typename Encoding, typename Allocator>

typedef reference GenericMemberIterator< Const, Encoding, Allocator >::Reference

Reference to (const) GenericMember.

◆ reference

template<bool Const, typename Encoding, typename Allocator>

typedef ValueType& GenericMemberIterator< Const, Encoding, Allocator >::reference

◆ value_type

template<bool Const, typename Encoding, typename Allocator>

typedef ValueType GenericMemberIterator< Const, Encoding, Allocator >::value_type

◆ ValueType

template<bool Const, typename Encoding, typename Allocator>

typedef internal::MaybeAddConst<Const,PlainType>::Type GenericMemberIterator< Const, Encoding, Allocator >::ValueType

private

Constructor & Destructor Documentation

◆ GenericMemberIterator() [1/3]

template<bool Const, typename Encoding, typename Allocator>

GenericMemberIterator< Const, Encoding, Allocator >::GenericMemberIterator ( )

inline

Default constructor (singular value).

Creates an iterator pointing to no element.

Note: All operations, except for comparisons, are undefined on such values.

◆ GenericMemberIterator() [2/3]

template<bool Const, typename Encoding, typename Allocator>

GenericMemberIterator< Const, Encoding, Allocator >::GenericMemberIterator ( const NonConstIterator & it )

inline

Iterator conversions to more const.

Parameters

it	(Non-const) iterator to copy from

Allows the creation of an iterator from another GenericMemberIterator that is "less const". Especially, creating a non-constant iterator from a constant iterator are disabled:

const -> non-const (not ok)
const -> const (ok)
non-const -> const (ok)
non-const -> non-const (ok)

Note: If the Const template parameter is already false, this constructor effectively defines a regular copy-constructor. Otherwise, the copy constructor is implicitly defined.

◆ GenericMemberIterator() [3/3]

template<bool Const, typename Encoding, typename Allocator>

GenericMemberIterator< Const, Encoding, Allocator >::GenericMemberIterator ( Pointer p )

inlineexplicitprivate

Internal constructor from plain pointer.

Member Function Documentation

◆ operator!=()

template<bool Const, typename Encoding, typename Allocator>

bool GenericMemberIterator< Const, Encoding, Allocator >::operator!= ( ConstIterator that ) const

inline

◆ operator*()

template<bool Const, typename Encoding, typename Allocator>

Reference GenericMemberIterator< Const, Encoding, Allocator >::operator* ( ) const

inline

◆ operator+()

template<bool Const, typename Encoding, typename Allocator>

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator+ ( DifferenceType n ) const

inline

◆ operator++() [1/2]

template<bool Const, typename Encoding, typename Allocator>

Iterator & GenericMemberIterator< Const, Encoding, Allocator >::operator++ ( )

inline

◆ operator++() [2/2]

template<bool Const, typename Encoding, typename Allocator>

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator++ ( int )

inline

◆ operator+=()

template<bool Const, typename Encoding, typename Allocator>

Iterator & GenericMemberIterator< Const, Encoding, Allocator >::operator+= ( DifferenceType n )

inline

◆ operator-() [1/2]

template<bool Const, typename Encoding, typename Allocator>

DifferenceType GenericMemberIterator< Const, Encoding, Allocator >::operator- ( ConstIterator that ) const

inline

Distance.

◆ operator-() [2/2]

template<bool Const, typename Encoding, typename Allocator>

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator- ( DifferenceType n ) const

inline

◆ operator--() [1/2]

template<bool Const, typename Encoding, typename Allocator>

Iterator & GenericMemberIterator< Const, Encoding, Allocator >::operator-- ( )

inline

◆ operator--() [2/2]

template<bool Const, typename Encoding, typename Allocator>

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator-- ( int )

inline

◆ operator-=()

template<bool Const, typename Encoding, typename Allocator>

Iterator & GenericMemberIterator< Const, Encoding, Allocator >::operator-= ( DifferenceType n )

inline

◆ operator->()

template<bool Const, typename Encoding, typename Allocator>

Pointer GenericMemberIterator< Const, Encoding, Allocator >::operator-> ( ) const

inline

◆ operator<()

template<bool Const, typename Encoding, typename Allocator>

bool GenericMemberIterator< Const, Encoding, Allocator >::operator< ( ConstIterator that ) const

inline

◆ operator<=()

template<bool Const, typename Encoding, typename Allocator>

bool GenericMemberIterator< Const, Encoding, Allocator >::operator<= ( ConstIterator that ) const

inline

◆ operator=()

template<bool Const, typename Encoding, typename Allocator>

Iterator & GenericMemberIterator< Const, Encoding, Allocator >::operator= ( const NonConstIterator & it )

inline

◆ operator==()

template<bool Const, typename Encoding, typename Allocator>

bool GenericMemberIterator< Const, Encoding, Allocator >::operator== ( ConstIterator that ) const

inline

◆ operator>()

template<bool Const, typename Encoding, typename Allocator>

bool GenericMemberIterator< Const, Encoding, Allocator >::operator> ( ConstIterator that ) const

inline

◆ operator>=()

template<bool Const, typename Encoding, typename Allocator>

bool GenericMemberIterator< Const, Encoding, Allocator >::operator>= ( ConstIterator that ) const

inline

◆ operator[]()

template<bool Const, typename Encoding, typename Allocator>

Reference GenericMemberIterator< Const, Encoding, Allocator >::operator[] ( DifferenceType n ) const

inline

◆ GenericMemberIterator

template<bool Const, typename Encoding, typename Allocator>

template<bool, typename, typename>

friend class GenericMemberIterator

friend

◆ GenericValue< Encoding, Allocator >

template<bool Const, typename Encoding, typename Allocator>

friend class GenericValue< Encoding, Allocator >

friend

Member Data Documentation

◆ ptr_

template<bool Const, typename Encoding, typename Allocator>

Pointer GenericMemberIterator< Const, Encoding, Allocator >::ptr_

private

raw pointer

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

external/rapidjson/include/rapidjson/document.h

Public Types

Public Member Functions

Private Types

Friends

std::iterator_traits support

dereference

Detailed Description

Member Typedef Documentation

◆ ConstIterator

◆ difference_type

◆ DifferenceType

◆ Iterator

◆ iterator_category

◆ NonConstIterator

◆ PlainType

◆ Pointer

◆ pointer

◆ Reference

◆ reference

◆ value_type

◆ ValueType

Constructor & Destructor Documentation

◆ GenericMemberIterator() [1/3]

◆ GenericMemberIterator() [2/3]

◆ GenericMemberIterator() [3/3]

Member Function Documentation

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator->()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

Friends And Related Symbol Documentation

◆ GenericMemberIterator

◆ GenericValue< Encoding, Allocator >

Member Data Documentation

◆ ptr_