z::core::iterable< ITER > Interface Template Reference

A base interface for all objects that can be iterated over. More...

#include <iterable.hpp>

Inheritance diagram for z::core::iterable< ITER >:

Public Member Functions
virtual	~iterable () noexcept
	Virtual destructor.
virtual ITER	begin () const noexcept=0
	Get an iterator for the first element in this object.
virtual ITER	end () const noexcept=0
	Get an iterator after the last element of this object.

Detailed Description

template<typename ITER>
interface z::core::iterable< ITER >

A base interface for all objects that can be iterated over.

Member Function Documentation

begin()

template<typename ITER >

virtual ITER z::core::iterable< ITER >::begin ( ) const

pure virtualnoexcept

Get an iterator for the first element in this object.

This member function should not be used directly. It is meant for C++11's range-based for loop syntax.

Returns

An iterator on the first element.

Implemented in z::core::array< T >, z::core::array< zstring * >, z::core::circularBuffer< TYPE, LEN >, z::core::generator< T, S >, z::core::string< E >, z::core::string< ascii >, and z::core::string< z::utf8 >.

end()

template<typename ITER >

virtual ITER z::core::iterable< ITER >::end ( ) const

pure virtualnoexcept

Get an iterator after the last element of this object.

This member function should not be used directly. It is meant for C++11's range-based for loop syntax.

Returns

An iterator after the last element.

Implemented in z::core::array< T >, z::core::array< zstring * >, z::core::circularBuffer< TYPE, LEN >, z::core::generator< T, S >, z::core::string< E >, z::core::string< ascii >, and z::core::string< z::utf8 >.

---

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

• z/core/iterable.hpp