ra8-firmware/ra8__io__stream__backend_8h_source.html

#pragma once


#ifdef __cplusplus

extern "C" {

#endif


#include <stdint.h>


#include "ra8_err.h"

#include "ra8_io_stream.h"


struct ra8_io_stream_iface {

  ra8_err_t (*write)(void* ctx, const uint8_t* buf, uint32_t len, uint32_t* out_written);


  ra8_err_t (*flush)(void* ctx);

};


[[nodiscard]] ra8_err_t

ra8_io_stream_bind(ra8_io_stream_t* stream, const ra8_io_stream_iface_t* iface, void* context);


#ifdef __cplusplus

}

#endif

write
-proof

ra8_err.h
Error Code Definitions for ra8-firmware.

ra8_err_t
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546

ra8_io_stream.h
ra8_io targetable byte-stream facade – one writer, many destinations.

ra8_io_stream_iface_t
struct ra8_io_stream_iface ra8_io_stream_iface_t
Definition ra8_io_stream.h:62

ra8_io_stream_bind
ra8_err_t ra8_io_stream_bind(ra8_io_stream_t *stream, const ra8_io_stream_iface_t *iface, void *context)
Bind a backend vtable and caller-owned state into a stream handle.
Definition ra8_io_stream.c:81

ra8_io_stream_iface
Opaque to stream users; backend implementers use the public backend contract in ra8_io_stream_backend...
Definition ra8_io_stream_backend.h:45

ra8_io_stream_iface::flush
ra8_err_t(* flush)(void *ctx)
Commit any buffering.
Definition ra8_io_stream_backend.h:53

ra8_io_stream_t
Caller-allocated byte-stream handle binding a sink to its context.
Definition ra8_io_stream.h:78