https://github.com/devyatsu/new-pkl
A rust crate to work with pkl files data efficiently!
https://github.com/devyatsu/new-pkl
Last synced: 8 months ago
JSON representation
A rust crate to work with pkl files data efficiently!
- Host: GitHub
- URL: https://github.com/devyatsu/new-pkl
- Owner: DevYatsu
- License: mit
- Created: 2024-06-20T23:49:46.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T00:35:21.000Z (almost 2 years ago)
- Last Synced: 2025-02-24T07:50:57.445Z (over 1 year ago)
- Language: Rust
- Homepage: https://crates.io/crates/new-pkl
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# new-pkl
Fastest pkl-parsing crate out there!
## Features
- Parse Pkl string into a structured representation (hashmap) in rust
- Parse Pkl string into an AST
- Support for strings, integers (decimal, octal, hex, binary), floats, boolean and multiline strings
- Support for nested objects, amends declaration, amends expression and chained amends declaration
- Support for classical identifiers, $identifiers, _identifiers and illegal identifiers
- Support for class instance
- Support for Duration and Datasize
## Installation
When in your rust project, simply run: `cargo add new-pkl`
## Usage
Here's an example of how to parse a PKL string and retrieve values from the context:
```rust
use new_pkl::{Pkl, PklResult, PklValue};
fn main() -> PklResult<()> {
let source = r#"
bool_var = true
int_var = 42
float_var = 3.14
string_var = "hello"
object_var {
key1 = "value1"
key2 = 2
}
"#;
let mut pkl = Pkl::new();
pkl.parse(source)?;
println!("{:?}", pkl.get("int_var")); // Ok(PklValue::Int(100))
// Get values
println!("{:?}", pkl.get_bool("bool_var")); // Ok(true)
println!("{:?}", pkl.get_int("int_var")); // Ok(42)
println!("{:?}", pkl.get_float("float_var")); // Ok(3.14)
println!("{:?}", pkl.get_string("string_var")); // Ok("hello")
println!("{:?}", pkl.get_object("object_var")); // Ok(HashMap with key1 and key2)
// Modify values
pkl.set("int_var", PklValue::Int(100));
// Remove values
pkl.remove("float_var");
println!("{:?}", pkl.get_float("float_var")); // Err("Variable `float_var` not found")
// Or just generate an ast
let mut pkl = Pkl::new();
// the ast contains the start and end indexes of each value and statement
let ast = pkl.generate_ast(source)?;
Ok(())
}
```
### LICENSE
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.