az_span_allocator_context Struct Reference

Defines a container of required and user-defined fields that provide the necessary information and parameters for the implementation of the az_span_allocator_fn callback. More...

#include <az_span.h>

Data Fields
void *	user_context
int32_t	bytes_used
int32_t	minimum_required_size

Detailed Description

Defines a container of required and user-defined fields that provide the necessary information and parameters for the implementation of the az_span_allocator_fn callback.

Field Documentation

bytes_used

int32_t az_span_allocator_context::bytes_used

The amount of space consumed (i.e. written into) within the previously provided destination, which can be used to infer the remaining number of bytes of the az_span that are leftover.

minimum_required_size

int32_t az_span_allocator_context::minimum_required_size

The minimum length of the destination az_span required to be provided by the callback. If 0, any non-empty sized buffer must be returned.

user_context

void* az_span_allocator_context::user_context

Any struct that was provided by the user for their specific implementation, passed through to the az_span_allocator_fn.

---

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

• sdk/inc/azure/core/az_span.h