roo_io
API Documentation for roo_io
Loading...
Searching...
No Matches
roo_io::UnsafeMemoryOutputIterator Class Reference

Infinite output iterator writing to memory from given address. More...

#include <memory_output_iterator.h>

Public Member Functions

 UnsafeMemoryOutputIterator (byte *ptr)
 Creates iterator starting at ptr.
 
void write (byte v)
 Writes one byte and advances output pointer.
 
size_t write (const byte *buf, size_t count)
 Writes count bytes and advances output pointer.
 
Status status () const
 Returns current status (kOk).
 
byteptr () const
 Returns current output pointer.
 
void flush ()
 Flushes output (no-op).
 

Detailed Description

Infinite output iterator writing to memory from given address.

Writer controls bounds externally.

Definition at line 13 of file memory_output_iterator.h.

Constructor & Destructor Documentation

◆ UnsafeMemoryOutputIterator()

roo_io::UnsafeMemoryOutputIterator::UnsafeMemoryOutputIterator ( byte ptr)
inline

Creates iterator starting at ptr.

Definition at line 16 of file memory_output_iterator.h.

Member Function Documentation

◆ flush()

void roo_io::UnsafeMemoryOutputIterator::flush ( )
inline

Flushes output (no-op).

Does not modify status.

Definition at line 47 of file memory_output_iterator.h.

◆ ptr()

byte * roo_io::UnsafeMemoryOutputIterator::ptr ( ) const
inline

Returns current output pointer.

Returns
Current pointer.

Definition at line 42 of file memory_output_iterator.h.

◆ status()

Status roo_io::UnsafeMemoryOutputIterator::status ( ) const
inline

Returns current status (kOk).

Returns
kOk.

Definition at line 37 of file memory_output_iterator.h.

References roo_io::kOk.

◆ write() [1/2]

void roo_io::UnsafeMemoryOutputIterator::write ( byte  v)
inline

Writes one byte and advances output pointer.

Does not modify status (status() is always kOk).

Definition at line 21 of file memory_output_iterator.h.

◆ write() [2/2]

size_t roo_io::UnsafeMemoryOutputIterator::write ( const byte buf,
size_t  count 
)
inline

Writes count bytes and advances output pointer.

Does not modify status (status() is always kOk).

Returns
Number of bytes written (count).

Definition at line 28 of file memory_output_iterator.h.

References roo_io::count.


The documentation for this class was generated from the following file: