ra8_io_stream_ram_state_t Struct Reference

Caller-owned private state for a RAM stream sink. More...

#include <ra8_io_stream_ram.h>

Data Fields
uint8_t *	buf
	Caller-owned capture buffer (private).
uint32_t	cap
	Buffer capacity in bytes (private).
uint32_t	len
	Bytes captured so far (private).

Detailed Description

Caller-owned private state for a RAM stream sink.

Zero-initialise and pass to ra8_io_stream_ram_init. Treat the fields as private; read the captured length back with ra8_io_stream_ram_used. The buffer and this state must out-live every call made through the stream.

Invariant

len <= cap.

Since

0.1.0

Definition at line 43 of file ra8_io_stream_ram.h.

Field Documentation

buf

uint8_t* ra8_io_stream_ram_state_t::buf

Caller-owned capture buffer (private).

Definition at line 44 of file ra8_io_stream_ram.h.

Referenced by internal_ram_write(), and ra8_io_stream_ram_init().

cap

uint32_t ra8_io_stream_ram_state_t::cap

Buffer capacity in bytes (private).

Definition at line 45 of file ra8_io_stream_ram.h.

Referenced by internal_ram_write(), and ra8_io_stream_ram_init().

len

uint32_t ra8_io_stream_ram_state_t::len

Bytes captured so far (private).

Definition at line 46 of file ra8_io_stream_ram.h.

Referenced by internal_ram_write(), ra8_io_stream_ram_init(), and ra8_io_stream_ram_used().

---

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

• libs/ra8_io/inc/ra8_io_stream_ram.h