Ingot User Guide

Ingot is a C code generator for embedded key-value databases. It reads a TOML data model specification and produces optimized C99 code with compile-time perfect hashing for O(1) key lookup. All storage is statically allocated – no heap, no dynamic memory, no fragmentation.

Contents

• Installation
  • From Source
  • From crates.io (When Published)
  • Prerequisites
• Quick Start
• CLI Reference
  • Required
  • Output & Target
  • Key Filtering
  • Variant Overrides
  • Verbosity
  • Targets
  • Examples
• Schema Reference
  • Meta
  • Enums
  • Classes
  • Key Attributes
  • Data Types
  • Per-Variant Defaults
  • Constraints
• Generated API
  • Initialization
  • Reading and Writing Values
  • String API
  • Helper Functions
  • Return Codes
  • Key Query Macros
  • Persistence
• Build System Integration
  • CMake
  • Make
  • ESP-IDF
• Testing Generated Code
• Examples
• 32-Bit Key Encoding
• Perfect Hash Algorithm