xiiStringReverseIterator Struct Reference

STL reverse iterator used by all string classes. Iterates over unicode characters. The iterator starts at the last character of the string and ends at the address before the first character of the string. More...

#include <StringIterator.h>

Public Types
using	iterator_category = std::bidirectional_iterator_tag
using	value_type = xiiUInt32
using	difference_type = std::ptrdiff_t
using	pointer = const char*
using	reference = xiiUInt32

Public Member Functions
	XII_DECLARE_POD_TYPE ()
XII_ALWAYS_INLINE	xiiStringReverseIterator ()=default
	Constructs an invalid iterator.
XII_FORCE_INLINE	xiiStringReverseIterator (const char *pStartPtr, const char *pEndPtr, const char *pCurPtr)
	Constructs either a rbegin or rend iterator for the given string.
XII_ALWAYS_INLINE bool	IsValid () const
	Checks whether this iterator points to a valid element.
XII_ALWAYS_INLINE xiiUInt32	GetCharacter () const
	Returns the currently pointed to character in Utf32 encoding.
XII_ALWAYS_INLINE xiiUInt32	operator* () const
	Returns the currently pointed to character in Utf32 encoding.
XII_ALWAYS_INLINE const char *	GetData () const
	Returns the address the iterator currently points to.
XII_ALWAYS_INLINE bool	operator== (const xiiStringReverseIterator &it2) const
	Checks whether the two iterators point to the same element.
XII_FORCE_INLINE xiiStringReverseIterator &	operator++ ()
	Move to the next Utf8 character.
XII_FORCE_INLINE xiiStringReverseIterator &	operator-- ()
	Move to the previous Utf8 character.
XII_ALWAYS_INLINE xiiStringReverseIterator	operator++ (xiiInt32)
	Move to the next Utf8 character.
XII_ALWAYS_INLINE xiiStringReverseIterator	operator-- (xiiInt32)
	Move to the previous Utf8 character.
XII_FORCE_INLINE void	operator+= (difference_type d)
	Advances the iterator forwards by d characters. Does not move it beyond the range's end.
XII_FORCE_INLINE void	operator-= (difference_type d)
	Moves the iterator backwards by d characters. Does not move it beyond the range's start.
XII_ALWAYS_INLINE xiiStringReverseIterator	operator+ (difference_type d) const
	Returns an iterator that is advanced forwards by d characters.
XII_ALWAYS_INLINE xiiStringReverseIterator	operator- (difference_type d) const
	Returns an iterator that is advanced backwards by d characters.
XII_FORCE_INLINE void	SetCurrentPosition (const char *szCurPos)
	Allows to set the 'current' iteration position to a different value.

Detailed Description

STL reverse iterator used by all string classes. Iterates over unicode characters. The iterator starts at the last character of the string and ends at the address before the first character of the string.

Member Function Documentation

SetCurrentPosition()

XII_FORCE_INLINE void xiiStringReverseIterator::SetCurrentPosition ( const char * szCurPos )

inline

Allows to set the 'current' iteration position to a different value.

Must be between the iterators start and end range.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Strings/Implementation/StringIterator.h