#format-string #string-interpolation #hash-map #variables #safe #secret #input

svi

a function to interpolate variables in a hashmap into a format string

5 releases (2 stable)

1.0.1 May 18, 2024
0.1.4 Mar 12, 2023

#672 in Algorithms

Download history 9/week @ 2024-05-27 29/week @ 2024-06-03 55/week @ 2024-06-10 8/week @ 2024-06-17 8/week @ 2024-07-01 1/week @ 2024-07-15 32/week @ 2024-07-29 50/week @ 2024-08-05 75/week @ 2024-08-12 15/week @ 2024-08-19 32/week @ 2024-08-26 3/week @ 2024-09-02 38/week @ 2024-09-09

110 downloads per month

MIT license

8KB
83 lines

SVI

string variable interpolator

this crate contains a function that interpolates variables in a hashmap into an input string, producing both the resulting string, plus a vec of 'replacers' to make output safe to store or print without compromising secrets.

variables can be matched with either [[variable_name]] (DoubleBrackets) or {{variable_name}} (DoubleCurlyBrackets).

Usage

let variables: HashMap<String, String> = [
	("mongo_username", "root"),
	("mongo_password", "mng233985725"),
]
.into_iter()
.map(|(k, v)| (k.to_string(), v.to_string()))
.collect();

let to_fmt = "mongodb://[[mongo_username]]:[[mongo_password]]@127.0.0.1:27017";

let (formatted, replacers) = svi::interpolate_variables(to_fmt, &variables, svi::Interpolator::DoubleBrackets)?;

println!("{formatted}"); // prints 'mongodb://root:mng233985725@127.0.0.1:27017'

// makes output involving replaced variables safe to print / store
let readable = svi::replace_in_string(&formatted, &replacers);

println!("{readable}"); // prints 'mongodb://<mongo_username>:<mongo_password>@127.0.0.1:27017'

Escaping Interpolation

let variables = HashMap::new();

let to_fmt = "the interpolator will escape interpolation with 3 openers: [[[not a variable]]]";

let (formatted, _) = svi::interpolate_variables(to_fmt, &variables, svi::Interpolator::DoubleBrackets)?;

println!("{formatted}"); // prints 'the interpolator will escape interpolation with 3 openers: [[not a variable]]'

Dependencies

~275–740KB
~17K SLoC