tinyutf8 4.0.2
Unicode (UTF-8) capable std::string
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
tiny_utf8::iterator_base< Container, Raw > Struct Template Reference

#include <tinyutf8.h>

Inheritance diagram for tiny_utf8::iterator_base< Container, Raw >:
Inheritance graph
[legend]

Public Types

typedef Container::value_type value_type
 
typedef Container::difference_type difference_type
 
typedef codepoint_reference< Container, falsereference
 
typedef voidpointer
 
typedef std::random_access_iterator_tag iterator_category
 

Public Member Functions

bool operator== (const iterator_base &it) const noexcept
 
bool operator!= (const iterator_base &it) const noexcept
 
 iterator_base (difference_type index, Container *instance) noexcept
 Ctor.
 
 iterator_base () noexcept=default
 Default function.
 
 iterator_base (const iterator_base &) noexcept=default
 
iterator_baseoperator= (const iterator_base &) noexcept=default
 
Containerget_instance () const noexcept
 Getter for the instance.
 
difference_type get_index () const noexcept
 
difference_type get_raw_index () const noexcept
 Get the index of the codepoint the iterator points to.
 
reference get_reference () const noexcept
 Get a reference to the codepoint the iterator points to.
 
value_type get_value () const noexcept
 Get the value that the iterator points to.
 

Protected Member Functions

void advance (difference_type n) noexcept
 Advance the iterator n times (negative values allowed!)
 
void increment () noexcept
 Move the iterator one codepoint ahead.
 
void decrement () noexcept
 Move the iterator one codepoint backwards.
 

Protected Attributes

difference_type t_index
 
Containert_instance = nullptr
 

Friends

template<typename , typename , typename >
class basic_string
 

Member Typedef Documentation

◆ difference_type

template<typename Container , bool Raw>
typedef Container::difference_type tiny_utf8::iterator_base< Container, Raw >::difference_type

◆ iterator_category

template<typename Container , bool Raw>
typedef std::random_access_iterator_tag tiny_utf8::iterator_base< Container, Raw >::iterator_category

◆ pointer

◆ reference

◆ value_type

template<typename Container , bool Raw>
typedef Container::value_type tiny_utf8::iterator_base< Container, Raw >::value_type

Constructor & Destructor Documentation

◆ iterator_base() [1/3]

template<typename Container , bool Raw>
tiny_utf8::iterator_base< Container, Raw >::iterator_base ( difference_type index,
Container * instance )
inlinenoexcept

Ctor.

◆ iterator_base() [2/3]

template<typename Container , bool Raw>
tiny_utf8::iterator_base< Container, Raw >::iterator_base ( )
defaultnoexcept

Default function.

◆ iterator_base() [3/3]

template<typename Container , bool Raw>
tiny_utf8::iterator_base< Container, Raw >::iterator_base ( const iterator_base< Container, Raw > & )
defaultnoexcept

Member Function Documentation

◆ advance()

template<typename Container , bool Raw>
void tiny_utf8::iterator_base< Container, Raw >::advance ( difference_type n)
inlineprotectednoexcept

Advance the iterator n times (negative values allowed!)

◆ decrement()

template<typename Container , bool Raw>
void tiny_utf8::iterator_base< Container, Raw >::decrement ( )
inlineprotectednoexcept

Move the iterator one codepoint backwards.

◆ get_index()

template<typename Container , bool Raw>
difference_type tiny_utf8::iterator_base< Container, Raw >::get_index ( ) const
inlinenoexcept

◆ get_instance()

template<typename Container , bool Raw>
Container * tiny_utf8::iterator_base< Container, Raw >::get_instance ( ) const
inlinenoexcept

Getter for the instance.

◆ get_raw_index()

template<typename Container , bool Raw>
difference_type tiny_utf8::iterator_base< Container, Raw >::get_raw_index ( ) const
inlinenoexcept

Get the index of the codepoint the iterator points to.

◆ get_reference()

template<typename Container , bool Raw>
reference tiny_utf8::iterator_base< Container, Raw >::get_reference ( ) const
inlinenoexcept

Get a reference to the codepoint the iterator points to.

◆ get_value()

template<typename Container , bool Raw>
value_type tiny_utf8::iterator_base< Container, Raw >::get_value ( ) const
inlinenoexcept

Get the value that the iterator points to.

◆ increment()

template<typename Container , bool Raw>
void tiny_utf8::iterator_base< Container, Raw >::increment ( )
inlineprotectednoexcept

Move the iterator one codepoint ahead.

◆ operator!=()

template<typename Container , bool Raw>
bool tiny_utf8::iterator_base< Container, Raw >::operator!= ( const iterator_base< Container, Raw > & it) const
inlinenoexcept

◆ operator=()

template<typename Container , bool Raw>
iterator_base & tiny_utf8::iterator_base< Container, Raw >::operator= ( const iterator_base< Container, Raw > & )
defaultnoexcept

◆ operator==()

template<typename Container , bool Raw>
bool tiny_utf8::iterator_base< Container, Raw >::operator== ( const iterator_base< Container, Raw > & it) const
inlinenoexcept

Friends And Related Symbol Documentation

◆ basic_string

template<typename Container , bool Raw>
template<typename , typename , typename >
friend class basic_string
friend

Member Data Documentation

◆ t_index

◆ t_instance

template<typename Container , bool Raw>
Container* tiny_utf8::iterator_base< Container, Raw >::t_instance = nullptr
protected

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