valve-keyvalue 1.0.3

A parser and serializer for the Valve KeyValue format (VMT/VDF).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

/*
   Copyright 2026 Gerg0Vagyok

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

use crate::{ValveKeyValue, ValveKeyValueType};
use crate::error::{Error, Result};

fn serialize_string(string: String, use_escape_sequences: bool) -> Result<String> {
	let temp_string = if use_escape_sequences {
		string
			.replace('\\', "\\\\")
			.replace('"', "\\\"")
			.replace('\n', "\\n")
			.replace('\t', "\\t")
	} else {
		if string.contains('"') {
			return Err(Error::QuoteInNonEscapeSequencedString);
		}
		string
	};

	if
		temp_string.contains(char::is_whitespace) ||
		temp_string.contains('"') ||
		temp_string.contains('\\') ||
		temp_string.is_empty()
	{
		Ok(format!("\"{}\"", temp_string))
	} else {
		Ok(temp_string)
	}
}

pub fn serialize_object(
	input: Vec<ValveKeyValue>,
	use_escape_sequences: bool,
	indentation_level: usize,
	indentation_steps: usize
) -> Result<String> {
	let mut full = String::new();

	for keypair in input {
		full.push_str(&format!(
			"{}{} {}\n",
			" ".repeat(indentation_level * indentation_steps),
			serialize_string(keypair.key, use_escape_sequences)?,
			match keypair.value {
				ValveKeyValueType::String(string) => serialize_string(string, use_escape_sequences)?,
				ValveKeyValueType::Object(object) => {
					format!(
						"{{\n{}{}}}",
						serialize_object(object, use_escape_sequences, indentation_level+1, indentation_steps)?,
						" ".repeat(indentation_level * indentation_steps)
					)
				}
			}
		));
	}

	Ok(full)
}

// small wrapper to make it nicer to use
pub fn serialize(input: Vec<ValveKeyValue>, use_escape_sequences: bool, indentation_steps: usize) -> Result<String> {
	serialize_object(input, use_escape_sequences, 0, indentation_steps)
}