IterPeekAt

Table of Contents

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.

Success

Data copied over to dst from current read position and mi is returned.

Failure

NULL_ITER_DATA(mi) returned.

Usage example (Cross-references)

    ///
    /// TAGS: StrIter, Peek, Character, Iter
    #define StrIterPeek(mi) IterPeekAt((mi), 0)
    
    ///
    ///
    /// TAGS: StrIter, Peek, Character, Iter
    #define StrIterPeekAt(mi, n) IterPeekAt((mi), (n))
    
    #define StrIterPeekNext(mi) IterPeekAt((mi), 1)
    #define StrIterPeekAt(mi, n) IterPeekAt((mi), (n))
    
    #define StrIterPeekNext(mi) IterPeekAt((mi), 1)
    #define StrIterPeekPrev(mi) IterPeekAt((mi), -1)
    
    #define StrIterPeekNext(mi) IterPeekAt((mi), 1)
    #define StrIterPeekPrev(mi) IterPeekAt((mi), -1)
    
    #endif // MISRA_STD_UTILITY_STR_ITER_H

Share :

Related Posts

IterNext

IterNext Description Move to next element (wrapper for IterMove)

Read More

IterPos

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

Read More

IterLength

IterLength Description Get total length of this Iter object

Read More