A UTF string iterator is a forward iterator that returns the code points of a UTF string. More...

#include <utf_string_iterator.h>

Inheritance diagram for cppgraph::utf_string_iterator_t< Code_Point >:

Public Member Functions
utf_string_t< Code_Point > const &	utf_string () const
	Returns a reference to this iterator's UTF string. More...

Public Member Functions inherited from cppgraph::forward_iterator_t< Code_Point, Code_Point const &, Code_Point const * >
bool	can_dereference () const
	Returns `true` if this iterator can be dereferenced. More...

bool	can_increment () const
	Returns `true` if this iterator can be incremented. More...

index_t	get_index () const
	Returns the container index of the item on which this iterator is positioned. More...

count_t	get_size () const
	Returns the number of items in the iterated collection. More...

Code_Point const &	operator* () const
	Returns a `Reference` to the current item. More...

void	operator++ ()
	Pre-increments the iterator. More...

Code_Point const *	operator-> () const
	Returns a `Pointer` to the current item. More...

Private Member Functions
void	on_begin () override
	Called by `to_begin()`. This base class version is a NOP.

void	on_incremented () override
	Called when this iterator has been incremented from an item in the range [0, size() - 1] to an item in the range [1, size]. This base class version is a NOP.

Detailed Description

A UTF string iterator is a forward iterator that returns the code points of a UTF string.

Template Parameters

Code_Point A Cppgraph UTF character class.

Member Function Documentation

template<typename Code_Point >

utf_string_t< Code_Point > const & cppgraph::utf_string_iterator_t< Code_Point >::utf_string ( ) const

Returns a reference to this iterator's UTF string.

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