--- name: "__gnu_debug::_Safe_iterator_base" section: "3cxx" platform: "linux" package: "libstdc++-12-doc" version: "12.4.0-5" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/__gnu_debug::_Safe_iterator_base/3cxx" --- # \_\_gnu\_debug::\_Safe\_iterator\_base(3cxx) Basic functionality for a safe iterator. ## NAME \_\_gnu\_debug::\_Safe\_iterator\_base - Basic functionality for a *safe* iterator. ## SYNOPSIS `#include ` Inherited by **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, std::forward\_iterator\_tag \>**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, std::bidirectional\_iterator\_tag \>**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>**, and **\_\_gnu\_debug::\_Safe\_local\_iterator\_base**. ### Public Member Functions bool **\_M\_attached\_to** (const **\_Safe\_sequence\_base** \*\_\_seq) const\ bool **\_M\_can\_compare** (const **\_Safe\_iterator\_base** &\_\_x) const throw ()\ void **\_M\_detach\_single** () throw ()\ void **\_M\_invalidate** ()\ void **\_M\_reset** () throw ()\ bool **\_M\_singular** () const throw ()\ void **\_M\_unlink** () throw ()\ ### Public Attributes **\_Safe\_iterator\_base** \* **\_M\_next**\ **\_Safe\_iterator\_base** \* **\_M\_prior**\ **\_Safe\_sequence\_base** \* **\_M\_sequence**\ unsigned int **\_M\_version**\ ### Protected Member Functions **\_Safe\_iterator\_base** ()\ **\_Safe\_iterator\_base** (const **\_Safe\_iterator\_base** &\_\_x, bool \_\_constant)\ **\_Safe\_iterator\_base** (const **\_Safe\_sequence\_base** \*\_\_seq, bool \_\_constant)\ void **\_M\_attach** (**\_Safe\_sequence\_base** \*\_\_seq, bool \_\_constant)\ void **\_M\_attach\_single** (**\_Safe\_sequence\_base** \*\_\_seq, bool \_\_constant) throw ()\ void **\_M\_detach** ()\ \_\_gnu\_cxx::\_\_mutex & **\_M\_get\_mutex** () throw ()\ ### Friends class **\_Safe\_sequence\_base**\ ## Detailed Description Basic functionality for a *safe* iterator. The \_Safe\_iterator\_base base class implements the functionality of a safe iterator that is not specific to a particular iterator type. It contains a pointer back to the sequence it references along with iterator version information and pointers to form a doubly-linked list of iterators referenced by the container. This class must not perform any operations that can throw an exception, or the exception guarantees of derived iterators will be broken. ## Constructor & Destructor Documentation ### \_\_gnu\_debug::\_Safe\_iterator\_base::\_Safe\_iterator\_base ()` [inline]`, ` [protected]` Initializes the iterator and makes it singular. ### \_\_gnu\_debug::\_Safe\_iterator\_base::\_Safe\_iterator\_base (const \_Safe\_sequence\_base \* \_\_seq, bool \_\_constant)` [inline]`, ` [protected]` Initialize the iterator to reference the sequence pointed to by `__seq`. `__constant` is true when we are initializing a constant iterator, and false if it is a mutable iterator. Note that `__seq` may be NULL, in which case the iterator will be singular. Otherwise, the iterator will reference `__seq` and be nonsingular. References **\_M\_attach()**. ### \_\_gnu\_debug::\_Safe\_iterator\_base::\_Safe\_iterator\_base (const \_Safe\_iterator\_base & \_\_x, bool \_\_constant)` [inline]`, ` [protected]` Initializes the iterator to reference the same sequence that `__x` does. `__constant` is true if this is a constant iterator, and false if it is mutable. References **\_M\_attach()**, and **\_M\_sequence**. ## Member Function Documentation ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_attach (\_Safe\_sequence\_base \* \_\_seq, bool \_\_constant)` [protected]` Attaches this iterator to the given sequence, detaching it from whatever sequence it was attached to originally. If the new sequence is the NULL pointer, the iterator is left unattached. Referenced by **\_Safe\_iterator\_base()**, **\_Safe\_iterator\_base()**, and **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::\_M\_attach()**. ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_attach\_single (\_Safe\_sequence\_base \* \_\_seq, bool \_\_constant)` [protected]` Likewise, but not thread-safe. Referenced by **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::\_M\_attach\_single()**. ### bool \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_attached\_to (const \_Safe\_sequence\_base \* \_\_seq) const` [inline]` Determines if we are attached to the given sequence. References **\_M\_sequence**. ### bool \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_can\_compare (const \_Safe\_iterator\_base & \_\_x) const Can we compare this iterator to the given iterator `__x`? Returns true if both iterators are nonsingular and reference the same sequence. ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_detach ()` [protected]` Detach the iterator for whatever sequence it is attached to, if any. Referenced by **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, and **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**. ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_detach\_single () Likewise, but not thread-safe. Referenced by **\_\_gnu\_debug::\_Safe\_sequence\< \_Sequence \>::\_M\_transfer\_from\_if()**. ### \_\_gnu\_cxx::\_\_mutex & \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_get\_mutex ()` [protected]` For use in \_Safe\_iterator. Referenced by **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator++()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator++()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator++()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator++()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, and **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**. ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_invalidate ()` [inline]` Invalidate the iterator, making it singular. References **\_M\_version**. ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_reset () Reset all member variables ### bool \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_singular () const Is this iterator singular? Referenced by **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::\_Safe\_iterator()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::\_Safe\_local\_iterator()**, **\_\_gnu\_debug::\_\_check\_singular\_aux()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::\_M\_dereferenceable()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::\_M\_dereferenceable()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::\_M\_incrementable()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::\_M\_incrementable()**, and **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**. ### void \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_unlink ()` [inline]` Unlink itself References **\_M\_next**, and **\_M\_prior**. ## Member Data Documentation ### \_Safe\_iterator\_base\* \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_next Pointer to the next iterator in the sequence's list of iterators. Only valid when \_M\_sequence != NULL. Referenced by **\_\_gnu\_debug::\_Safe\_sequence\< \_SafeSequence \>::\_M\_invalidate\_if()**, **\_\_gnu\_debug::\_Safe\_sequence\< \_Sequence \>::\_M\_transfer\_from\_if()**, and **\_M\_unlink()**. ### \_Safe\_iterator\_base\* \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_prior Pointer to the previous iterator in the sequence's list of iterators. Only valid when \_M\_sequence != NULL. Referenced by **\_\_gnu\_debug::\_Safe\_sequence\< \_SafeSequence \>::\_M\_invalidate\_if()**, **\_\_gnu\_debug::\_Safe\_sequence\< \_Sequence \>::\_M\_transfer\_from\_if()**, and **\_M\_unlink()**. ### \_Safe\_sequence\_base\* \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_sequence The sequence this iterator references; may be NULL to indicate a singular iterator. Referenced by **\_Safe\_iterator\_base()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\_base::\_Safe\_local\_iterator\_base()**, **\_M\_attached\_to()**, **\_\_gnu\_debug::\_Safe\_sequence\< \_Sequence \>::\_M\_transfer\_from\_if()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator++()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator++()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, and **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**. ### unsigned int \_\_gnu\_debug::\_Safe\_iterator\_base::\_M\_version The version number of this iterator. The sentinel value 0 is used to indicate an invalidated iterator (i.e., one that is singular because of an operation on the container). This version number must equal the version number in the sequence referenced by \_M\_sequence for the iterator to be non-singular. Referenced by **\_M\_invalidate()**, **\_\_gnu\_debug::\_Safe\_sequence\< \_Sequence \>::\_M\_transfer\_from\_if()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**, **\_\_gnu\_debug::\_Safe\_iterator\< \_Iterator, \_Sequence, \_Category \>::operator=()**, and **\_\_gnu\_debug::\_Safe\_local\_iterator\< \_Iterator, \_Sequence \>::operator=()**. ## Author Generated automatically by Doxygen for libstdc++ from the source code.