RWUEncodingNameStandardListIterator Class Reference

A C++ Standard Library-compatible random-access iterator for class RWUEncodingNameStandardList. More...

#include <rw/i18n/RWUEncodingNameStandardListIterator.h>

Public Types
typedef int32_t	difference_type
typedef std::random_access_iterator_tag	iterator_category
typedef value_type *	pointer
typedef value_type	reference
typedef const char *	value_type

Public Member Functions
	RWUEncodingNameStandardListIterator (const RWUEncodingNameStandardListIterator &source)
	RWUEncodingNameStandardListIterator (void)
	~RWUEncodingNameStandardListIterator ()
value_type	operator* () const
RWUEncodingNameStandardListIterator &	operator++ ()
RWUEncodingNameStandardListIterator	operator++ (int)
RWUEncodingNameStandardListIterator &	operator+= (difference_type offset)
difference_type	operator- (const RWUEncodingNameStandardListIterator &rhs) const
RWUEncodingNameStandardListIterator &	operator-- ()
RWUEncodingNameStandardListIterator	operator-- (int)
RWUEncodingNameStandardListIterator &	operator-= (difference_type offset)
RWUEncodingNameStandardListIterator &	operator= (const RWUEncodingNameStandardListIterator &rhs)
value_type	operator[] (difference_type offset) const

Friends
std::strong_ordering	operator<=> (const RWUEncodingNameStandardListIterator &lhs, const RWUEncodingNameStandardListIterator &rhs)
bool	operator== (const RWUEncodingNameStandardListIterator &lhs, const RWUEncodingNameStandardListIterator &rhs)
class	RWUEncodingNameStandardList

Related Symbols
(Note that these are not member symbols.)
RWUEncodingNameStandardListIterator	operator+ (const RWUEncodingNameStandardListIterator &lhs, RWUEncodingNameStandardListIterator::difference_type offset)
RWUEncodingNameStandardListIterator	operator+ (RWUEncodingNameStandardListIterator::difference_type offset, const RWUEncodingNameStandardListIterator &rhs)
RWUEncodingNameStandardListIterator	operator- (const RWUEncodingNameStandardListIterator &lhs, RWUEncodingNameStandardListIterator::difference_type offset)

Detailed Description

RWUEncodingNameStandardListIterator is a C++ Standard Library-compatible random-access iterator for class RWUEncodingNameStandardList. An instance of RWUEncodingNameStandardListIterator can be used to access the list of encoding name standards that are currently recognized by the Internationalization Module. The list cannot be changed at run time.

Example

#include <rw/i18n/RWUEncodingNameStandardList.h>
#include <iostream>
 
int main() {
  // Iterate over the list of standards and write them
  // to std::cout, obtaining iterators from the static
  // RWUEncodingNameStandardListIterator begin() and end()
  // methods.
  RWUEncodingNameStandardListIterator iter;
  for (iter = RWUEncodingNameStandardList::begin();
       iter != RWUEncodingNameStandardList::end(); ++iter) {
    std::cout << *iter << std::endl;
  }
 
  // Iterate over the list of standards again, obtaining
  // iterators from an RWUEncodingNameStandardList object.
  RWUEncodingNameStandardList list;
  for (iter = list.begin(); iter != list.end(); ++iter) {
    std::cout << *iter << std::endl;
  }
 
  return 0;
}

See also

RWUEncodingNameStandardList

Member Typedef Documentation

difference_type

typedef int32_t RWUEncodingNameStandardListIterator::difference_type

Declares an alias for the type used to represent iterator offsets and differences.

iterator_category

typedef std::random_access_iterator_tag RWUEncodingNameStandardListIterator::iterator_category

Tags this class as a C++ Standard Library-compatible random-access iterator.

pointer

typedef value_type* RWUEncodingNameStandardListIterator::pointer

Declares an alias for the value pointer type.

reference

typedef value_type RWUEncodingNameStandardListIterator::reference

Declares an alias for the value reference type.

value_type

typedef const char* RWUEncodingNameStandardListIterator::value_type

Declares an alias for the value type returned by operator*().

Constructor & Destructor Documentation

RWUEncodingNameStandardListIterator() [1/2]

RWUEncodingNameStandardListIterator::RWUEncodingNameStandardListIterator ( void )

inline

Default constructor. Creates an invalid iterator. Attempts to dereference an invalid iterator throw RWBoundsErr. Use RWUEncodingNameStandardList to obtain valid iterators.

RWUEncodingNameStandardListIterator() [2/2]

RWUEncodingNameStandardListIterator::RWUEncodingNameStandardListIterator ( const RWUEncodingNameStandardListIterator & source )

inline

Copy constructor.

~RWUEncodingNameStandardListIterator()

RWUEncodingNameStandardListIterator::~RWUEncodingNameStandardListIterator ( )

inline

Destructor.

Member Function Documentation

operator*()

RWUEncodingNameStandardListIterator::value_type RWUEncodingNameStandardListIterator::operator* ( ) const

inline

Returns a const char* to a null-terminated character string that contains the name of the encoding name standard located at the list position specified by self.

The storage for this string is owned by the library.

Exceptions

RWBoundsErr

Thrown if the iterator is invalid or positioned past the end of the list.

operator++() [1/2]

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator++ ( )

inline

Repositions self to the next position in the encoding name standard list and returns a reference to self.

operator++() [2/2]

RWUEncodingNameStandardListIterator RWUEncodingNameStandardListIterator::operator++ ( int )

inline

Repositions self to the next position in the encoding name standard list and returns a copy of the previous value of self.

operator+=()

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator+= ( difference_type offset )

inline

Repositions self to a new position in the encoding name standard list by adding offset to the current iterator position, and returns a reference to self.

operator-()

RWUEncodingNameStandardListIterator::difference_type RWUEncodingNameStandardListIterator::operator- ( const RWUEncodingNameStandardListIterator & rhs ) const

inline

Calculates the difference, or distance, between self and rhs.

operator--() [1/2]

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator-- ( )

inline

Repositions self to the preceding position in the encoding name standard list and returns a reference to self.

operator--() [2/2]

RWUEncodingNameStandardListIterator RWUEncodingNameStandardListIterator::operator-- ( int )

inline

Repositions self to the preceding position in the encoding name standard list and returns a copy of the previous value of self.

operator-=()

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator-= ( difference_type offset )

inline

Repositions self to a new position in the encoding name standard list by subtracting offset from the current iterator position, and returns a reference to self.

operator=()

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator= ( const RWUEncodingNameStandardListIterator & rhs )

inline

Changes the state of self to match that of rhs.

operator[]()

RWUEncodingNameStandardListIterator::value_type RWUEncodingNameStandardListIterator::operator[] ( difference_type offset ) const

inline

Returns a const char* to a null-terminated character string that contains the name of the encoding name standard located at the list position specified by the given offset from self.

Friends And Related Symbol Documentation

operator+() [1/2]

RWUEncodingNameStandardListIterator operator+ ( const RWUEncodingNameStandardListIterator & lhs, RWUEncodingNameStandardListIterator::difference_type offset )

related

Returns a new iterator whose list position is calculated by adding offset to the position of lhs.

operator+() [2/2]

RWUEncodingNameStandardListIterator operator+ ( RWUEncodingNameStandardListIterator::difference_type offset, const RWUEncodingNameStandardListIterator & rhs )

related

Returns a new iterator whose list position is calculated by adding offset to the position of rhs.

operator-()

RWUEncodingNameStandardListIterator operator- ( const RWUEncodingNameStandardListIterator & lhs, RWUEncodingNameStandardListIterator::difference_type offset )

related

Returns a new iterator whose list position is calculated by subtracting offset from the position of lhs.

operator<=>

std::strong_ordering operator<=> ( const RWUEncodingNameStandardListIterator & lhs, const RWUEncodingNameStandardListIterator & rhs )

friend

Performs a comparison of the list position of lhs and rhs.

Note

If a compiler does not support rewritten expressions (i.e. before C++20), comparison operators are explicitly implemented to provide equivalent behavior.

operator==

bool operator== ( const RWUEncodingNameStandardListIterator & lhs, const RWUEncodingNameStandardListIterator & rhs )

friend

Returns true if the list position of lhs is equal to the list position of rhs. Otherwise, returns false.

Note

If a compiler does not support rewritten expressions (i.e. before C++20), equality operators are explicitly implemented to provide equivalent behavior.