Skip to main content

Module options

Module options 

Source
Expand description

Option map types passed from Confium into a plugin’s create entry point.

The wire shape mirrors confium_core::options::Options exactly so a pointer of one can be reinterpreted as the other across the FFI boundary. Plugin authors get typed accessors (OptionView::get_str, OptionView::get_u32, OptionView::get_map) without depending on confium-core.

The proc-macro generated cfmp_<iface>_create reinterprets the *const Options argument as &OptionMap (they share a layout) and hands the borrow to the trait method.

Structs§

OptionView
Read-only view over an OptionMap borrowed across the FFI.

Enums§

OptionValue
Discriminated union of the option values that may flow across the FFI option map. Layout-compatible with confium_core::options::OptionValue.

Type Aliases§

OptionMap
A string-keyed map of OptionValues, layout-compatible with confium_core::options::Options (HashMap<String, OptionValue>).