- Nominal Typing
- Trait-Based
- Two-Level
- Decode-Encode Dual
- Literal
A KDL file format parser with great error reporting and convenient derive macros.
To give you some background on the KDL format. Here is a small example:
foo 1 "three" key="val" {
bar
(role)baz 1 2
}Here is what are annotations for all the datum as described by the specification and this guide:
foo 1 "three" key="val" { โฎ
โโฌโ โฌ โโโโฌโโโ โโโโโฌโโโโ โ
โ โ โ โฐโโโโโ property (can be multiple) โ
โ โ โ โ
โ โฐโโโโโดโโโโโโโโโโโโโโ arguments โ
โ โ
โฐโโ node name โโ node "foo", with
โ "bar" and "baz"
bar โ being children
(role)baz 1 2 โ
โโโฌโ โ
โฐโโโโโโ type name for node named "baz" โ
} โฏ
Most common usage of this library is using derive and [decode] or [decode_children] function:
use kfl::{Decode, DecodePartial, Encode};
use std::path::PathBuf;
#[cfg(feature = "http")]
use http::Uri;
#[derive(DecodePartial, Default)]
struct Document {
#[kfl(children)]
routes: Vec<Route>,
#[kfl(children)]
plugins: Vec<Plugin>,
}
#[derive(Decode, Encode)]
struct Route {
#[kfl(argument)]
path: PathBuf,
#[kfl(children)]
subroutes: Vec<Route>,
}
#[derive(Decode, Encode)]
struct Plugin {
#[kfl(argument)]
name: String,
#[cfg(feature = "http")]
#[kfl(property)]
url: Uri,
}
# fn main() -> miette::Result<()> {
let document = kfl::decode_children::<Document>("example.kdl", r#"
route /api {
route /api/v1
}
plugin "http" url=https://example.org/http
"#)?;
# Ok(())
# }Licensed under either of
- Apache License, Version 2.0, (./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.