util::iterator_guard< ContainerType, IsConst > Class Template Reference

#include <iterator_guard.h>

Collaboration diagram for util::iterator_guard< ContainerType, IsConst >:

Public Types
using	iterator_type = typename std::conditional< IsConst, typename ContainerType::const_iterator, typename ContainerType::iterator >::type
using	reference = typename std::iterator_traits< iterator_type >::reference
using	pointer = typename std::iterator_traits< iterator_type >::pointer
using	value_type = typename std::iterator_traits< iterator_type >::value_type

Public Member Functions
LIBCOPP_UTIL_FORCEINLINE void	set (const ContainerType &owner, iterator_type v) LIBCOPP_MACRO_NOEXCEPT
LIBCOPP_UTIL_FORCEINLINE void	reset (const ContainerType &owner) LIBCOPP_MACRO_NOEXCEPT
LIBCOPP_UTIL_FORCEINLINE iterator_type	release (const ContainerType &owner)
LIBCOPP_UTIL_FORCEINLINE bool	valid (const ContainerType &owner) const LIBCOPP_MACRO_NOEXCEPT
LIBCOPP_UTIL_FORCEINLINE reference	operator* () const LIBCOPP_MACRO_NOEXCEPT
LIBCOPP_UTIL_FORCEINLINE pointer	operator-> () const LIBCOPP_MACRO_NOEXCEPT
LIBCOPP_UTIL_FORCEINLINE	iterator_guard () LIBCOPP_MACRO_NOEXCEPT

Private Attributes
const ContainerType *	owner_
iterator_type	iter_

Detailed Description

template<class ContainerType, bool IsConst = false>
class util::iterator_guard< ContainerType, IsConst >

Definition at line 15 of file iterator_guard.h.

Member Typedef Documentation

iterator_type

template<class ContainerType , bool IsConst = false>

using util::iterator_guard< ContainerType, IsConst >::iterator_type = typename std::conditional<IsConst, typename ContainerType::const_iterator, typename ContainerType::iterator>::type

Definition at line 17 of file iterator_guard.h.

pointer

template<class ContainerType , bool IsConst = false>

using util::iterator_guard< ContainerType, IsConst >::pointer = typename std::iterator_traits<iterator_type>::pointer

Definition at line 21 of file iterator_guard.h.

reference

template<class ContainerType , bool IsConst = false>

using util::iterator_guard< ContainerType, IsConst >::reference = typename std::iterator_traits<iterator_type>::reference

Definition at line 20 of file iterator_guard.h.

value_type

template<class ContainerType , bool IsConst = false>

using util::iterator_guard< ContainerType, IsConst >::value_type = typename std::iterator_traits<iterator_type>::value_type

Definition at line 22 of file iterator_guard.h.

Constructor & Destructor Documentation

iterator_guard()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE util::iterator_guard< ContainerType, IsConst >::iterator_guard ( )

inline

Definition at line 54 of file iterator_guard.h.

Member Function Documentation

operator*()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE reference util::iterator_guard< ContainerType, IsConst >::operator* ( ) const

inline

Definition at line 50 of file iterator_guard.h.

operator->()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE pointer util::iterator_guard< ContainerType, IsConst >::operator-> ( ) const

inline

Definition at line 52 of file iterator_guard.h.

release()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE iterator_type util::iterator_guard< ContainerType, IsConst >::release ( const ContainerType &  owner )

inline

Definition at line 34 of file iterator_guard.h.

reset()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE void util::iterator_guard< ContainerType, IsConst >::reset ( const ContainerType &  owner )

inline

Definition at line 29 of file iterator_guard.h.

set()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE void util::iterator_guard< ContainerType, IsConst >::set ( const ContainerType &  owner, iterator_type  v  )

inline

Definition at line 24 of file iterator_guard.h.

valid()

template<class ContainerType , bool IsConst = false>

LIBCOPP_UTIL_FORCEINLINE bool util::iterator_guard< ContainerType, IsConst >::valid ( const ContainerType &  owner ) const

inline

Definition at line 42 of file iterator_guard.h.

Field Documentation

iter_

template<class ContainerType , bool IsConst = false>

iterator_type util::iterator_guard< ContainerType, IsConst >::iter_

private

Definition at line 58 of file iterator_guard.h.

owner_

template<class ContainerType , bool IsConst = false>

const ContainerType* util::iterator_guard< ContainerType, IsConst >::owner_

private

Definition at line 57 of file iterator_guard.h.

---

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

• /home/runner/work/libcopp/libcopp/include/libcopp/utils/iterator_guard.h