User Guide

Documentation for using liblevenshtein-rust in your projects.

Getting Started

Getting Started

Quick start guide for new users:

• Installation instructions
• Basic usage examples
• Choosing algorithms and backends
• First fuzzy matching queries

Core Guides

Algorithms

Deep dive into Levenshtein distance algorithms:

• Standard Levenshtein distance
• Transposition (optimal string alignment / restricted Damerau)
• Unrestricted Damerau–Levenshtein with composable edits
• Merge and Split operations
• Algorithm selection guide
• Distance threshold tuning
• Regular-language queries with query_language and query_regex

Dictionary Backends

Comprehensive backend comparison and selection guide:

• DoubleArrayTrie (recommended default)
• PathMap (dynamic updates)
• DAWG variants (space-efficient)
• SuffixAutomaton (substring matching)
• Unicode support with character-level variants
• Performance characteristics and trade-offs

Serialization

Save and load dictionaries efficiently:

• Supported compact formats (bincode and Protocol Buffers)
• Optional gzip wrappers
• Format comparison and selection
• Link to the separate liblevenshtein-cli command documentation
• Best practices

Feature Guides

Features

Comprehensive overview of all library features:

• Levenshtein distance computation
• Fuzzy search capabilities
• Multiple dictionary backends
• Serialization options
• Cache eviction strategies
• SIMD acceleration

Code Completion Guide

Build code completion with liblevenshtein:

• Setting up dictionaries
• Configuring fuzzy matching
• Optimizing for IDE integration
• Performance tuning

Thread Safety

Concurrent access patterns:

• Thread safety guarantees
• Dynamic dictionary updates
• Synchronization strategies
• Best practices for multi-threaded applications

Additional Resources

• Main README - Project overview and quick examples
• Developer Guide - Contributing and architecture
• Design Documents - Technical specifications
• Benchmarks - Performance measurements