Record-Jar structured text database reader for Rust — part of the cross-language Open-RJ family.
recordjar reads Record-JAR databases: text files (or in-memory buffers) of
records separated by %% lines, each record holding name: value fields.
Continuation lines, comments, and the implemented parse-time flags are
supported by the memory parser; file I/O, field aliases, and field lookup
remain planned.
Reference in Cargo.toml in the usual way:
recordjar = { version = "0.0.2" }| Type | Purpose |
|---|---|
Database |
Parsed Record-JAR database |
Record |
Record with comment and fields |
Field |
Single name: value field |
ParseFlags |
Parse-time behaviour flags |
Error |
Operation and parse errors |
ParseErrorKind |
Parse error classification |
ParseErrorDetail |
Line/column parse failure detail |
Memory parsing is implemented for records, fields, comments, continuations, parse errors, blank-record elision, field ordering, and single-record mode. File I/O, field aliases, and field lookup remain under development.
| Function | Purpose |
|---|---|
Database::from_str() |
Parse from memory |
Database::from_path() |
Parse from file path (not yet implemented) |
Record::find_field_by_name() |
Field lookup (not yet implemented) |
See EXAMPLES.md for the available examples.
Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/recordjar.Rust.
The declared Minimum Supported Rust Version (MSRV) for recordjar.Rust is 1.74.
This MSRV guarantee applies to the library crate itself, its runtime dependencies ([dependencies]), and its build dependencies ([build-dependencies]). Downstream consumers compiling this crate as a dependency are guaranteed that it builds cleanly on the declared MSRV toolchain.
Development dependencies ([dev-dependencies], such as benchmarking frameworks like criterion) may require newer Rust toolchains for local development or performance testing. These dev-dependencies are never fetched or compiled by downstream consumers and do not affect the library's MSRV guarantee.
None.
recordjar.Rust is released under the 3-clause BSD license. See LICENSE for details.