59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
# toml_edit
|
|
|
|
[](https://github.com/ordian/toml_edit/actions)
|
|
[](https://codecov.io/gh/ordian/toml_edit)
|
|
[](https://crates.io/crates/toml_edit)
|
|
[](https://docs.rs/toml_edit)
|
|
[](https://gitter.im/toml_edit/Lobby)
|
|
|
|
|
|
This crate allows you to parse and modify toml
|
|
documents, while preserving comments, spaces *and
|
|
relative order* or items.
|
|
|
|
`toml_edit` is primarily tailored for [cargo-edit](https://github.com/killercup/cargo-edit/) needs.
|
|
|
|
## Example
|
|
|
|
```rust
|
|
use toml_edit::{Document, value};
|
|
|
|
fn main() {
|
|
let toml = r#"
|
|
"hello" = 'toml!' # comment
|
|
['a'.b]
|
|
"#;
|
|
let mut doc = toml.parse::<Document>().expect("invalid doc");
|
|
assert_eq!(doc.to_string(), toml);
|
|
// let's add a new key/value pair inside a.b: c = {d = "hello"}
|
|
doc["a"]["b"]["c"]["d"] = value("hello");
|
|
// autoformat inline table a.b.c: { d = "hello" }
|
|
doc["a"]["b"]["c"].as_inline_table_mut().map(|t| t.fmt());
|
|
let expected = r#"
|
|
"hello" = 'toml!' # comment
|
|
['a'.b]
|
|
c = { d = "hello" }
|
|
"#;
|
|
assert_eq!(doc.to_string(), expected);
|
|
}
|
|
```
|
|
|
|
## Limitations
|
|
|
|
Things it does not preserve:
|
|
|
|
* Scattered array of tables (tables are reordered by default, see [test]).
|
|
* Order of dotted keys, see [issue](https://github.com/ordian/toml_edit/issues/163).
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://apache.org/licenses/LICENSE-2.0)
|
|
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
### Contribution
|
|
|
|
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.
|
|
|
|
[test]: https://github.com/ordian/toml_edit/blob/f09bd5d075fdb7d2ef8d9bb3270a34506c276753/tests/test_valid.rs#L84
|