api

LNMP API Documentation

Comprehensive API reference for all LNMP implementations.

📚 Documentation Structure

Rust Core API

• v0.5 (Latest) - Advanced features: Binary nested structures, streaming, delta encoding
• v0.3 (Legacy) - Core types, parser, encoder, semantic fidelity

Language SDKs

• TypeScript SDK - WASM-based TypeScript/JavaScript SDK
• Python SDK - PyO3-based native Python bindings
• Rust SDK - Meta-crate for direct Rust usage
• Go SDK - Native Go implementation

Tools & CLIs

• CLI Tools - Command-line interface
• MCP Server - Model Context Protocol server

---

🗺️ Quick Navigation

Core Concepts

• Types & Values
• Records & Fields
• Checksums

Encoding & Decoding

• Parser
• Encoder
• Binary Format

Advanced Features (v0.5)

• Streaming
• Delta Encoding
• Schema Negotiation

Optimization

• LLM Bridge (LLB)
• Semantic Fidelity (SFE)

---

📖 Version Guide

Version	Status	Features	Recommended For
v0.5	⭐ Latest	Nested structures, streaming, delta	Production use
v0.3	Legacy	Core protocol, basic features	Legacy systems

---

🚀 Getting Started

Rust

use lnmp::prelude::*;

// Parse LNMP text
let mut parser = Parser::new("F12=14532\nF7=1")?;
let record = parser.parse_record()?;

// Encode to text
let encoder = Encoder::new();
let output = encoder.encode(&record);

TypeScript

import { Core, Encoder } from '@lnmplang/lnmp';

// Parse LNMP text
const record = Core.parse("F12=14532\nF7=1");

// Encode to text
const output = Encoder.encode(record);

Python

import lnmp

# Parse LNMP text
record = lnmp.parse("F12=14532\nF7=1")

# Encode to text
output = lnmp.encode(record)

---

🔗 External Resources

• LNMP Specification - Formal protocol specification
• Grammar Reference - PEG grammar
• Examples - Code examples
• Crates.io - Rust crate documentation

---

📝 Contributing

To update or add API documentation:

1. Rust API: Edit files in docs/api/rust/
2. SDK API: Edit SDK-specific docs in respective SDK directories
3. Cross-reference: Use relative links to keep docs connected

License

MIT License - See LICENSE for details