options_builder_t Struct Reference

Options builder. More...

#include <lib/options/builder.h>

Data Fields
option_descriptor_t *	descriptors
	Dynamic array of descriptors.
size_t	num_descriptors
	Current count.
size_t	descriptor_capacity
	Allocated capacity.
option_dependency_t *	dependencies
	Dynamic array of dependencies.
size_t	num_dependencies
	Current count.
size_t	dependency_capacity
	Allocated capacity.
positional_arg_descriptor_t *	positional_args
	Dynamic array of positional args.
size_t	num_positional_args
	Current count.
size_t	positional_arg_capacity
	Allocated capacity.
size_t	struct_size
	Target struct size.
const char *	program_name
	Program name for usage.
const char *	description
	Program description for usage.

Detailed Description

Options builder.

For incrementally constructing option configurations. Use builder functions to add options and dependencies, then build an immutable config.

Definition at line 192 of file builder.h.

Field Documentation

dependencies

option_dependency_t* options_builder_t::dependencies

Dynamic array of dependencies.

Definition at line 197 of file builder.h.

Referenced by options_builder_add_dependency(), options_builder_add_dependency_conflicts(), options_builder_add_dependency_implies(), options_builder_add_dependency_requires(), options_builder_build(), options_builder_create(), and options_builder_destroy().

dependency_capacity

size_t options_builder_t::dependency_capacity

Allocated capacity.

Definition at line 199 of file builder.h.

Referenced by options_builder_create().

description

const char* options_builder_t::description

Program description for usage.

Definition at line 207 of file builder.h.

Referenced by options_builder_build(), options_builder_create(), options_builder_from_preset(), options_preset_acds(), options_preset_binary(), options_preset_client(), options_preset_mirror(), and options_preset_server().

descriptor_capacity

size_t options_builder_t::descriptor_capacity

Allocated capacity.

Definition at line 195 of file builder.h.

Referenced by options_builder_create().

descriptors

option_descriptor_t* options_builder_t::descriptors

Dynamic array of descriptors.

Definition at line 193 of file builder.h.

Referenced by options_builder_add_action(), options_builder_add_bool(), options_builder_add_callback(), options_builder_add_callback_optional(), options_builder_add_descriptor(), options_builder_add_double(), options_builder_add_int(), options_builder_add_string(), options_builder_build(), options_builder_create(), options_builder_destroy(), and options_builder_mark_binary_only().

num_dependencies

size_t options_builder_t::num_dependencies

Current count.

Definition at line 198 of file builder.h.

Referenced by options_builder_add_dependency(), options_builder_add_dependency_conflicts(), options_builder_add_dependency_implies(), options_builder_add_dependency_requires(), options_builder_build(), and options_builder_create().

num_descriptors

size_t options_builder_t::num_descriptors

Current count.

Definition at line 194 of file builder.h.

Referenced by options_builder_add_action(), options_builder_add_bool(), options_builder_add_callback(), options_builder_add_callback_optional(), options_builder_add_descriptor(), options_builder_add_double(), options_builder_add_int(), options_builder_add_string(), options_builder_build(), options_builder_create(), and options_builder_mark_binary_only().

num_positional_args

size_t options_builder_t::num_positional_args

Current count.

Definition at line 202 of file builder.h.

Referenced by options_builder_add_positional(), options_builder_build(), and options_builder_create().

positional_arg_capacity

size_t options_builder_t::positional_arg_capacity

Allocated capacity.

Definition at line 203 of file builder.h.

Referenced by options_builder_create().

positional_args

positional_arg_descriptor_t* options_builder_t::positional_args

Dynamic array of positional args.

Definition at line 201 of file builder.h.

Referenced by options_builder_add_positional(), options_builder_build(), options_builder_create(), and options_builder_destroy().

program_name

const char* options_builder_t::program_name

Program name for usage.

Definition at line 206 of file builder.h.

Referenced by options_builder_build(), options_builder_create(), options_builder_from_preset(), options_preset_acds(), options_preset_binary(), options_preset_client(), options_preset_mirror(), and options_preset_server().

struct_size

size_t options_builder_t::struct_size

Target struct size.

Definition at line 205 of file builder.h.

Referenced by options_builder_build(), and options_builder_create().

---

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

• builder.h