annotate_toml_array_of_tables

soar_core::toml

Function annotate_toml_array_of_tables 

Source 
pub fn annotate_toml_array_of_tables<T>(
    array: &mut ArrayOfTables,
) -> Result<(), ConfigError>
where
    T: Documented + DocumentedFields,
Expand description

Annotates the first table in a TOML ArrayOfTables using documentation from the given struct T.

This assumes that the structure of all tables in the array is the same, so only the first table is annotated.

§Arguments

  • array - Mutable reference to the TOML array of tables to annotate.

§Returns

Returns Ok(()) if annotation succeeds, or a ConfigError if annotation fails on the first table.