Crate oak_source_map 

🗺️ oak-source-map

High-Performance Source Map v3 Implementation for Rust — A complete, zero-copy Source Map v3 implementation with VLQ encoding/decoding, builder patterns, and map composition.

🎯 Why oak-source-map?

Source maps are essential for debugging bundled and minified code. oak-source-map provides a high-performance, feature-complete implementation of the Source Map v3 specification, designed for both parsing and generating source maps efficiently.

✨ Key Features

• 📋 Full v3 Specification Support — Complete implementation of the Source Map v3 format
• ⚡ VLQ Base64 Encoding/Decoding — Fast and efficient VLQ processing
• 🔄 Zero-Copy Parsing — Minimal memory overhead when parsing existing maps
• 🏗️ Builder Pattern — Incremental source map construction
• 🎭 Source Map Composition — Combine multiple source maps for chained transformations
• 🔍 Mapping Lookup — Efficient line/column mapping queries
• 🔌 Serde Integration — Seamless serialization and deserialization

🏗️ Architecture

• SourceMap — Core source map representation
• SourceMapBuilder — Incremental map construction
• SourceMapComposer — Map composition for chained transformations
• SourceMapDecoder — Parser for existing source maps
• vlq — VLQ Base64 encoding/decoding utilities
• mapping — Mapping and segment data structures

🔗 Ecosystem Integration

Used by Oak language tools for debugging support and by bundlers and minifiers in the Rust ecosystem.

📖 Documentation

For usage examples and API details, see the API documentation.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Structs

BoundedMapping

A mapping with bounds information for efficient lookup.

Mapping

A single mapping entry in a source map.

Segment

A segment in the mappings string.

SourceMap

Source Map v3 representation.

SourceMapBuilder

Builder for incrementally constructing source maps.

SourceMapComposer

Composer for combining multiple source maps.

SourceMapDecoder

Decoder for efficient source map lookups.

SourceMapMetadata

Metadata about a source map.

Enums

SourceMapError

Error type for source map operations.

SourceMapInput

Input source for source map parsing.

Constants

DEFAULT_SOURCE_ROOT

The default source root.

SOURCE_MAP_VERSION

Source Map version (always 3).

Functions

vlq_decode

Decodes a VLQ Base64 string to a signed integer.

vlq_decode_many

Decodes multiple VLQ values from a string segment.

vlq_encode

Encodes a signed integer to VLQ Base64 string.

vlq_encode_many

Encodes multiple values into a VLQ string with separators.

Type Aliases

Result

Result type alias for source map operations.