PraetDescriptor Struct Reference

One transfer, written down. More...

Data Fields
const uint8_t *	source
uint8_t *	destination
embed_word	bytes
PraetDescriptor *	next
uint8_t	source_addressing
uint8_t	destination_addressing
uint8_t	ego_sum_mensura
uint8_t	directio_motus_verbi
uint8_t	owner

Detailed Description

One transfer, written down.

Parameters

source	First byte read [BORROWS].
destination	First byte written [BORROWS].
bytes	How many bytes the transfer moves.
next	The descriptor that runs after this one, or NULL where nothing does [BORROWS].
source_addressing	Whether the source address advances, as a PraetAddressing.
destination_addressing	Whether the destination address advances.
ego_sum_mensura	Bytes moved in one step, as an EgoSumMensura. Every offset, every length and the boundary a recovery rounds to are counted in it.
directio_motus_verbi	Which way the words are walked, as a DirectioMotusVerbi.
owner	Who holds it, as a PraetDescriptorOwner.

Note

Every field except owner is settled when the descriptor is declared. A declaration emits it as initialized data, and so nothing runs to make one usable.

Warning

source and destination belong to whoever declared the pools they came from, and this holds neither. The declarator is what proves those pools exist and that the spans fit inside them.

Definition at line 146 of file praet_descriptor.h.

Field Documentation

source

const uint8_t* PraetDescriptor::source

Definition at line 148 of file praet_descriptor.h.

destination

uint8_t* PraetDescriptor::destination

Definition at line 149 of file praet_descriptor.h.

bytes

embed_word PraetDescriptor::bytes

Definition at line 150 of file praet_descriptor.h.

next

PraetDescriptor* PraetDescriptor::next

Definition at line 151 of file praet_descriptor.h.

source_addressing

uint8_t PraetDescriptor::source_addressing

Definition at line 152 of file praet_descriptor.h.

destination_addressing

uint8_t PraetDescriptor::destination_addressing

Definition at line 153 of file praet_descriptor.h.

ego_sum_mensura

uint8_t PraetDescriptor::ego_sum_mensura

Definition at line 154 of file praet_descriptor.h.

directio_motus_verbi

uint8_t PraetDescriptor::directio_motus_verbi

Definition at line 155 of file praet_descriptor.h.

owner

uint8_t PraetDescriptor::owner

Definition at line 156 of file praet_descriptor.h.

---

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

• src/memoriam_praetereo/praet_descriptor.h