ra8_io_stream_t Struct Reference

Caller-allocated byte-stream handle binding a sink to its context. More...

#include <ra8_io_stream.h>

Collaboration diagram for ra8_io_stream_t:

Data Fields
const ra8_io_stream_iface_t *	iface
	Bound sink vtable (private).
void *	ctx
	Sink-private context (private).

Detailed Description

Caller-allocated byte-stream handle binding a sink to its context.

Zero-initialise (= {}) and pass to a sink _init() helper, which fills the vtable and context. Treat the fields as private; reach the sink only through the ra8_io_stream_* functions. The handle and the sink's context must out-live every call made through them.

Invariant

iface is non-NULL once a sink has been bound.

Since

0.1.0

Definition at line 78 of file ra8_io_stream.h.

Field Documentation

ctx

void* ra8_io_stream_t::ctx

Sink-private context (private).

Definition at line 80 of file ra8_io_stream.h.

Referenced by ra8_io_stream_flush(), and ra8_io_stream_write().

iface

const ra8_io_stream_iface_t* ra8_io_stream_t::iface

Bound sink vtable (private).

Definition at line 79 of file ra8_io_stream.h.

Referenced by internal_validate(), ra8_io_log_attach(), ra8_io_stream_flush(), and ra8_io_stream_write().

---

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

• libs/ra8_io/inc/ra8_io_stream.h