Documentation

IterInitT

Macro

IterInitT Description Initialize default Iter object to iterate in forward direction.

IterLength

Macro

IterLength Description Get total length of this Iter object

IterMove

Macro

IterMove Description Move current reading position of Iterator.

IterNext

Macro

IterNext Description Move to next element (wrapper for IterMove)

IterPeekAt Description Peek (not read) object from memory iter, given that - Provided Iter object is not NULL_ITER(mi). - There’s space left to read. - Length of object data is being read into is an integral multiple of size of data type this memory iter is iterating over. This is different from reading because it does not change current read position. This is good for making some decisions over data without changing the read position.

IterPos

Macro

IterPos Description If there’s space left to read in memory region we’re iterating over, then return a pointer to current read position.

IterPrev

Macro

IterPrev Description Move to previous element (wrapper for IterMove)

IterRead

Macro

IterRead Description Read object from memory iter, given that - Provided Iter object is not NULL_ITER(mi). - There’s space left to read. - Length of object data is being read into is an integral multiple of size of data type this memory iter is iterating over.