C Container Collection (CCC)
Loading...
Searching...
No Matches
CCC_Arguments Struct Reference

A reference to a user type within the container. More...

#include <types.h>

Detailed Description

A reference to a user type within the container.

Arguments are accepted by functions that allow the user to modify a type stored in a container. See the priority queue containers and their update, increase, and decrease capabilities as an example.

The pointers are const to bind the user type closely with its context, if context is provided. Because container code is providing the user a reference to a user type it currently stores, it is critical the user does not accidentally move or misuse the pointer to jeopardize container invariants.

Data Fields

void *const type
 
void *const context
 

Field Documentation

◆ context

void* const CCC_Arguments::context

A reference to context for this action on a type.

◆ type

void* const CCC_Arguments::type

The user type being stored in the container.


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