Provided by: libstdc++-9-doc_9.4.0-1ubuntu1~20.04.2_all
NAME
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence > - Safe iterator wrapper.
SYNOPSIS
Public Types typedef _Traits::difference_type difference_type typedef _Traits::iterator_category iterator_category typedef _Iterator iterator_type typedef _Traits::pointer pointer typedef _Traits::reference reference typedef _Traits::value_type value_type Public Member Functions _Safe_local_iterator () noexcept _Safe_local_iterator (_Iterator __i, const _Safe_sequence_base *__cont) Safe iterator construction from an unsafe iterator and its sequence. _Safe_local_iterator (_Safe_local_iterator &&__x) noexcept Move construction. _Safe_local_iterator (const _Safe_local_iterator &__x) noexcept Copy construction. template<typename _MutableIterator > _Safe_local_iterator (const _Safe_local_iterator< _MutableIterator, typename __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same< _MutableIterator, _OtherIterator >::__value, _Sequence >::__type > &__x) noexcept Converting constructor from a mutable iterator to a constant iterator. void _M_attach (_Safe_sequence_base *__seq) void _M_attach_single (_Safe_sequence_base *__seq) bool _M_dereferenceable () const Is the iterator dereferenceable? _Distance_traits< _Iterator >::__type _M_get_distance_to (const _Safe_local_iterator &__rhs) const __gnu_cxx::__conditional_type< _IsConstant::__value, const _Sequence *, _Sequence * >::__type _M_get_sequence () const template<typename _Other > bool _M_in_same_bucket (const _Safe_local_iterator< _Other, _Sequence > &__other) const Is this iterator part of the same bucket as the other one? bool _M_incrementable () const Is the iterator incrementable? bool _M_is_begin () const Is this iterator equal to the sequence's begin(bucket) iterator? bool _M_is_end () const Is this iterator equal to the sequence's end(bucket) iterator? bool _M_valid_range (const _Safe_local_iterator &__rhs, std::pair< difference_type, _Distance_precision > &__dist_info) const const _Iterator & base () const noexcept _Iterator & base () noexcept Return the underlying iterator. size_type bucket () const Return the bucket. operator _Iterator () const Conversion to underlying non-debug iterator to allow better interaction with non-debug containers. reference operator* () const Iterator dereference. _Safe_local_iterator & operator++ () Iterator preincrement. _Safe_local_iterator operator++ (int) Iterator postincrement. pointer operator-> () const Iterator dereference. _Safe_local_iterator & operator= (_Safe_local_iterator &&__x) noexcept Move assignment. _Safe_local_iterator & operator= (const _Safe_local_iterator &__x) Copy assignment. Static Public Member Functions static constexpr bool _S_constant () Determine if this is a constant iterator. Friends bool operator!= (const _Self &__lhs, const _OtherSelf &__rhs) noexcept bool operator!= (const _Self &__lhs, const _Self &__rhs) noexcept bool operator== (const _Self &__lhs, const _OtherSelf &__rhs) noexcept bool operator== (const _Self &__lhs, const _Self &__rhs) noexcept
Detailed Description
template<typename _Iterator, typename _Sequence> class __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >" Safe iterator wrapper. The class template _Safe_local_iterator is a wrapper around an iterator that tracks the iterator's movement among sequences and checks that operations performed on the 'safe' iterator are legal. In additional to the basic iterator operations (which are validated, and then passed to the underlying iterator), _Safe_local_iterator has member functions for iterator invalidation, attaching/detaching the iterator from sequences, and querying the iterator's state. Definition at line 83 of file formatter.h.
Constructor & Destructor Documentation
template<typename _Iterator , typename _Sequence > __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator () [inline], [noexcept] Postcondition the iterator is singular and unattached Definition at line 102 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator (_Iterator __i, const _Safe_sequence_base * __cont) [inline] Safe iterator construction from an unsafe iterator and its sequence. Precondition seq is not NULL Postcondition this is not singular Definition at line 111 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator (const _Safe_local_iterator< _Iterator, _Sequence > & __x) [inline], [noexcept] Copy construction. Definition at line 122 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator (_Safe_local_iterator< _Iterator, _Sequence > && __x) [inline], [noexcept] Move construction. Postcondition __x is singular and unattached Definition at line 139 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > template<typename _MutableIterator > __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator (const _Safe_local_iterator< _MutableIterator, typename __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same< _MutableIterator, _OtherIterator >::__value, _Sequence >::__type > & __x) [inline], [noexcept] Converting constructor from a mutable iterator to a constant iterator. Definition at line 158 of file safe_local_iterator.h.
Member Function Documentation
template<typename _Iterator , typename _Sequence > void __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_attach (_Safe_sequence_base * __seq) [inline] Attach iterator to the given sequence. Definition at line 326 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator_base::_M_attach(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_S_constant(). template<typename _Iterator , typename _Sequence > void __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_attach_single (_Safe_sequence_base * __seq) [inline] Likewise, but not thread-safe. Definition at line 331 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator_base::_M_attach_single(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_S_constant(). template<typename _Iterator , typename _Sequence > bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_dereferenceable () const [inline] Is the iterator dereferenceable? Definition at line 336 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_end(). template<typename _Iterator , typename _Sequence > template<typename _Other > bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_in_same_bucket (const _Safe_local_iterator< _Other, _Sequence > & __other) const [inline] Is this iterator part of the same bucket as the other one? Definition at line 371 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::bucket(). template<typename _Iterator , typename _Sequence > bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_incrementable () const [inline] Is the iterator incrementable? Definition at line 341 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_end(). template<typename _Iterator , typename _Sequence > bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_begin () const [inline] Is this iterator equal to the sequence's begin(bucket) iterator? Definition at line 361 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::base(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::bucket(). template<typename _Iterator , typename _Sequence > bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_end () const [inline] Is this iterator equal to the sequence's end(bucket) iterator? Definition at line 365 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::base(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::bucket(). Referenced by __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_dereferenceable(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_incrementable(). template<typename _Iterator , typename _Sequence > static constexpr bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_S_constant () [inline], [static], [constexpr] Determine if this is a constant iterator. Definition at line 300 of file safe_local_iterator.h. Referenced by __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_attach(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_attach_single(). template<typename _Iterator , typename _Sequence > _Iterator& __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::base () [inline], [noexcept] Return the underlying iterator. Definition at line 307 of file safe_local_iterator.h. Referenced by __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_begin(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_end(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::bucket(). template<typename _Iterator , typename _Sequence > size_type __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::bucket () const [inline] Return the bucket. Definition at line 316 of file safe_local_iterator.h. References __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::base(). Referenced by __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_in_same_bucket(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_begin(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_end(). template<typename _Iterator , typename _Sequence > __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator _Iterator () const [inline] Conversion to underlying non-debug iterator to allow better interaction with non-debug containers. Definition at line 322 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > reference __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator* () const [inline] Iterator dereference. Precondition iterator is dereferenceable Definition at line 244 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > _Safe_local_iterator& __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator++ () [inline] Iterator preincrement. Precondition iterator is incrementable Definition at line 271 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > _Safe_local_iterator __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator++ (int) [inline] Iterator postincrement. Precondition iterator is incrementable Definition at line 286 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > pointer __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator-> () const [inline] Iterator dereference. Precondition iterator is dereferenceable Definition at line 257 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > _Safe_local_iterator& __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator= (_Safe_local_iterator< _Iterator, _Sequence > && __x) [inline], [noexcept] Move assignment. Postcondition __x is singular and unattached Definition at line 210 of file safe_local_iterator.h. template<typename _Iterator , typename _Sequence > _Safe_local_iterator& __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator= (const _Safe_local_iterator< _Iterator, _Sequence > & __x) [inline] Copy assignment. Definition at line 179 of file safe_local_iterator.h.
Author
Generated automatically by Doxygen for libstdc++ from the source code. libstdc++ __gnu_debug::tSafe2local_iterator< _Iterator, _Sequence >(3cxx)