Reference Documentation

Welcome to the OxiDex reference documentation. This section provides detailed technical information about the library architecture, APIs, and supported formats.

Contents

Architecture

Learn about OxiDex's internal design, including the hexagonal architecture, parser system, and core abstractions.

API Reference

Comprehensive Rust library API documentation with examples and usage patterns.

FFI API

C-compatible Foreign Function Interface for integrating OxiDex with other programming languages (Python, Node.js, Go, etc.).

Tag Database

Information about the metadata tag database, including supported tag families and auto-generation from ExifTool source.

Tag Coverage Analysis

Detailed analysis of the gap between defined tags and extracted tags, with recommendations for improving coverage.

ExifTool Compatibility

Empirical comparison against ExifTool, including the JPEG Tag Support mapping (every ExifTool tag OxiDex reads/writes, with working keys and example values) and the full JPEG Tag Matrix (per-tag classification and known-bug inventory, regression-gated in CI).

Supported Formats

Complete list of supported file formats with implementation details and coverage information.

Quick Links

• Getting Started: See the Guide section for installation and usage instructions
• Performance: Check out Performance benchmarks for speed comparisons
• Contributing: Read the Contributing guide to get involved