#serialization #toml #pretty #array #value #structs #tabs

toml_pretty

a function to pretty serialize a serde-serializable value to toml

10 releases (stable)

1.1.2 Jun 11, 2024
1.0.3 Jun 11, 2024
0.3.0 Jun 11, 2024
0.2.0 Jun 11, 2024
0.1.0 Jun 10, 2024

#1645 in Encoding

Download history 11/week @ 2024-11-15 29/week @ 2024-11-22 11/week @ 2024-11-29 22/week @ 2024-12-06 6/week @ 2024-12-13 4/week @ 2025-01-24 80/week @ 2025-01-31 91/week @ 2025-02-07 36/week @ 2025-02-14 20/week @ 2025-02-21 10/week @ 2025-02-28

205 downloads per month

MIT license

10KB
210 lines

toml_pretty

A function to pretty serialize a serde-serializable value to toml.

Can serialize structs to toml in a single block (unlike the toml crate, which is great for deserialization but not so great for pretty serialization)

Nested array fields more than 2 arrays deep are not supported.

Note. All items in arrays are on a new line and indented. toml_pretty::to_string uses \t by default as tab. An alternal tab symbol can be used (eg. 2 spaces) using the Options (shown in example).

Example

Given serializable structs:

#[derive(Serialize)]
struct User {
  name: String,
  nicknames: Vec<String>,
  birthday: Birthday,
  more: Vec<Birthday>,
}

#[derive(Serialize)]
struct Birthday {
  day: u8,
  month: u8,
  year: u16,
}

Can use toml_pretty::to_string:

let user = User {
	name: String::from("Jonathan"),
	nicknames: vec![String::from("Jack"), String::from("Jon")],
	birthday: Birthday {
		day: 0,
		month: 0,
		year: 1980,
	},
	more: vec![
		Birthday {
			day: 0,
			month: 0,
			year: 1980,
		},
		Birthday {
			day: 0,
			month: 0,
			year: 1980,
		},
	],
};
println!(
	"{}",
	toml_pretty::to_string(&user, toml_pretty::Options::default().tab("  "))
		.context("failed to serialize user pretty")
		.unwrap()
);

Dependencies

~2.2–3MB
~56K SLoC