xo-umbrella2/xo-arena/docs/DArenaIterator-reference.rst
Roland Conybeare c08be29994 git subrepo clone git@github.com:Rconybea/xo-arena.git xo-arena
subrepo:
  subdir:   "xo-arena"
  merged:   "5567b43c"
upstream:
  origin:   "git@github.com:Rconybea/xo-arena.git"
  branch:   "main"
  commit:   "5567b43c"
git-subrepo:
  version:  "0.4.9"
  origin:   "???"
  commit:   "???"
2026-06-06 21:38:46 -04:00

50 lines
1.2 KiB
ReStructuredText

.. _DArenaIterator-reference:
DArenaIterator
==============
Iterator for allocs obtained from a :cpp:class:`xo::mm::DArena`.
Context
-------
.. ditaa::
:--scale: 0.99
+-----------------------------------------------------+
| DArena |
| DArenaIterator cBLU|
+-----------------------------------------------------+
| ArenaConfig |
+--------------+------------------------+-------------+
| | AllocInfo | |
| +------------------------+ |
| AllocError | AllocHeaderConfig | cmpresult |
| +------------------------+ |
| | AllocHeader | |
+--------------+------------------------+-------------+
.. code-block:: cpp
#include <xo/arena/DArenaIterator.hpp>
Class
-----
.. doxygenclass:: xo::mm::DArenaIterator
Member Variables
----------------
.. doxygengroup:: mm-arenaiterator-instance-vars
Constructors
------------
.. doxygengroup:: mm-arenaiterator-ctors
Methods
-------
.. doxygengroup:: mm-arenaiterator-methods