Matchy Reference

The reference covers the details of various areas of Matchy.

This section provides comprehensive technical documentation for Matchy's APIs, formats, and internals. For conceptual explanations, see the Matchy Guide.

Rust API

Detailed documentation for using Matchy from Rust:

• The Rust API - Overview and quick reference
• DatabaseBuilder - Building databases
• Database and Querying - Opening and querying
• Data Types Reference - Complete type reference
• Error Handling - Error types and handling
• Validation API - Database validation

C API

Detailed documentation for using Matchy from C/C++:

• The C API - Overview and quick reference
• Building Databases from C - Builder API
• Querying from C - Query API
• Memory Management - Memory rules

Format and Architecture

Technical specifications:

• Binary Format Specification - Database file format
• MMDB Integration Design - MaxMind compatibility
• Input File Formats - CSV, JSON, TSV formats
• Architecture Overview - Internal design

Performance

Detailed performance documentation:

• Performance Benchmarks - Comprehensive benchmark results