BitorumCfg Struct Reference

Arguments for the bitor calls, where each call reads only the members it needs. More...

#include <bitorum_introitus_exitus.h>

Data Fields
mmgr_bitor *const	writer
uint8_t *const	out
const size_t	cap
const uint64_t	val
const embed_word	bit_count

Detailed Description

Arguments for the bitor calls, where each call reads only the members it needs.

Note

mmgr_bitor_init reads out and cap. mmgr_bitor_put reads writer, val and bit_count. mmgr_bitor_align reads writer alone.

One argument type for all three entries, and so every call has the same shape and an unnamed member is zeroed and not left undefined.

Definition at line 53 of file bitorum_introitus_exitus.h.

Field Documentation

writer

mmgr_bitor* const BitorumCfg::writer

Writer for mmgr_bitor_put and mmgr_bitor_align [BORROWS].

Definition at line 55 of file bitorum_introitus_exitus.h.

out

uint8_t* const BitorumCfg::out

Buffer for mmgr_bitor_init [BORROWS].

Definition at line 56 of file bitorum_introitus_exitus.h.

cap

const size_t BitorumCfg::cap

Bytes available in out.

Definition at line 57 of file bitorum_introitus_exitus.h.

val

const uint64_t BitorumCfg::val

Bits for mmgr_bitor_put, taken from the low end.

Definition at line 58 of file bitorum_introitus_exitus.h.

bit_count

const embed_word BitorumCfg::bit_count

Bits of val to write, which must not exceed 64.

Definition at line 59 of file bitorum_introitus_exitus.h.

---

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

• src/bitorum_introitus_exitus/bitorum_introitus_exitus.h