u5e::utf8_const_iterator< NativeIterator > Class Template Reference

const iterator for utf8 encoded strings. More...

#include <u5e/utf8_iterator.hpp>

Inheritance diagram for u5e::utf8_const_iterator< NativeIterator >:

Collaboration diagram for u5e::utf8_const_iterator< NativeIterator >:

Public Types
typedef utf8_const_iterator	pointer
Public Types inherited from u5e::utf8_iterator_base< NativeIterator >
typedef codepoint	value_type
typedef const codepoint &	reference
typedef int	difference_type
typedef std::bidirectional_iterator_tag	iterator_category

Public Member Functions
	utf8_const_iterator (const NativeIterator raw_iterator)
	utf8_const_iterator (const utf8_const_iterator &tocopy)
const codepoint	operator* ()
utf8_const_iterator &	operator++ ()
utf8_const_iterator	operator++ (int junk)
utf8_const_iterator &	operator-- ()
utf8_const_iterator	operator-- (int junk)
bool	operator== (const utf8_const_iterator &rhs) const
bool	operator!= (const utf8_const_iterator &rhs) const
Public Member Functions inherited from u5e::utf8_iterator_base< NativeIterator >
	utf8_iterator_base (const NativeIterator raw_iterator)
bool	rewind_to_start_of_codepoint (const char current_octet)
void	forward_one_codepoint ()
void	rewind_one_codepoint ()
const codepoint	current_codepoint ()

Additional Inherited Members
Public Attributes inherited from u5e::utf8_iterator_base< NativeIterator >
iterator_assertion< NativeIterator, char >	_assertions
NativeIterator	raw_iterator_

Detailed Description

template<typename NativeIterator>
class u5e::utf8_const_iterator< NativeIterator >

const iterator for utf8 encoded strings.

Template Parameters

NativeIterator

The underlying type to be iterated over.

Definition at line 110 of file utf8_iterator.hpp.

Member Typedef Documentation

template<typename NativeIterator >

typedef utf8_const_iterator u5e::utf8_const_iterator< NativeIterator >::pointer

Offers itself as the pointer type

Definition at line 116 of file utf8_iterator.hpp.

Constructor & Destructor Documentation

template<typename NativeIterator >

u5e::utf8_const_iterator< NativeIterator >::utf8_const_iterator ( const NativeIterator  raw_iterator )

inline

Create from the underlying iterator type

Definition at line 121 of file utf8_iterator.hpp.

template<typename NativeIterator >

u5e::utf8_const_iterator< NativeIterator >::utf8_const_iterator ( const utf8_const_iterator< NativeIterator > &  tocopy )

inline

Copy constructor

Definition at line 127 of file utf8_iterator.hpp.

Member Function Documentation

template<typename NativeIterator >

bool u5e::utf8_const_iterator< NativeIterator >::operator!= ( const utf8_const_iterator< NativeIterator > &  rhs ) const

inline

Compare with another iterator

Definition at line 183 of file utf8_iterator.hpp.

template<typename NativeIterator >

const codepoint u5e::utf8_const_iterator< NativeIterator >::operator* ( )

inline

Dereference the current codepoint out of the iterator

Definition at line 191 of file utf8_iterator.hpp.

template<typename NativeIterator >

utf8_const_iterator& u5e::utf8_const_iterator< NativeIterator >::operator++ ( )

inline

Advance the iterator

Definition at line 134 of file utf8_iterator.hpp.

template<typename NativeIterator >

utf8_const_iterator u5e::utf8_const_iterator< NativeIterator >::operator++ ( int  junk )

inline

Advance the iterator

Definition at line 139 of file utf8_iterator.hpp.

template<typename NativeIterator >

utf8_const_iterator& u5e::utf8_const_iterator< NativeIterator >::operator-- ( )

inline

Rewinds the iterator

Definition at line 150 of file utf8_iterator.hpp.

template<typename NativeIterator >

utf8_const_iterator u5e::utf8_const_iterator< NativeIterator >::operator-- ( int  junk )

inline

Rewinds the iterator

Definition at line 155 of file utf8_iterator.hpp.

template<typename NativeIterator >

bool u5e::utf8_const_iterator< NativeIterator >::operator== ( const utf8_const_iterator< NativeIterator > &  rhs ) const

inline

Compare with another iterator

Definition at line 166 of file utf8_iterator.hpp.

---

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

• u5e/utf8_iterator.hpp