ra8_mdl_storage_ram_t Struct Reference

Mutable transaction over one caller-owned destination span. More...

#include <ra8_mdl_storage_ram.h>

Data Fields
uint8_t *	data
	Caller-owned backing bytes.
size_t	capacity
	Writable backing capacity.
size_t	length
	Private or committed byte count.
bool	active
	A transfer may append bytes.
bool	committed
	A read-only view may be exposed.

Detailed Description

Mutable transaction over one caller-owned destination span.

Treat members as private after ra8_mdl_storage_ram_init; obtain committed bytes only through ra8_mdl_storage_ram_view.

Invariant

length <= capacity and nonzero capacity implies non-NULL data.

active and committed are never true simultaneously.

Since

0.1.0

Definition at line 41 of file ra8_mdl_storage_ram.h.

Field Documentation

active

bool ra8_mdl_storage_ram_t::active

A transfer may append bytes.

Definition at line 45 of file ra8_mdl_storage_ram.h.

Referenced by internal_ram_abort(), internal_ram_begin(), internal_ram_commit(), internal_ram_write(), and ra8_mdl_storage_ram_view().

capacity

size_t ra8_mdl_storage_ram_t::capacity

Writable backing capacity.

Definition at line 43 of file ra8_mdl_storage_ram.h.

Referenced by internal_ram_write().

committed

bool ra8_mdl_storage_ram_t::committed

A read-only view may be exposed.

Definition at line 46 of file ra8_mdl_storage_ram.h.

Referenced by internal_ram_abort(), internal_ram_begin(), internal_ram_commit(), and ra8_mdl_storage_ram_view().

data

uint8_t* ra8_mdl_storage_ram_t::data

Caller-owned backing bytes.

Definition at line 42 of file ra8_mdl_storage_ram.h.

Referenced by internal_ram_write(), and ra8_mdl_storage_ram_view().

length

size_t ra8_mdl_storage_ram_t::length

Private or committed byte count.

Definition at line 44 of file ra8_mdl_storage_ram.h.

Referenced by internal_ram_abort(), internal_ram_begin(), internal_ram_commit(), internal_ram_write(), and ra8_mdl_storage_ram_view().

---

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

• libs/ra8_c6link/inc/ra8_mdl_storage_ram.h