punktf-lib 2.0.2

Library for punktf, a cross-platform multi-target dotfiles manager
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

//! User defined variables used by [profiles](`crate::profile::Profile`) and
//! [dotfiles](`crate::profile::dotfile::Dotfile`).

use std::collections::HashMap;
use std::ops::Deref;

use serde::{Deserialize, Serialize};

/// Variables that replace values in templates
pub trait Vars {
	/// Get a variable by name
	fn var<K: AsRef<str>>(&self, key: K) -> Option<&str>;
}

/// User defined variables
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Variables {
	/// User defined variables with a name and value.
	#[serde(flatten)]
	pub inner: HashMap<String, String>,
}

impl Vars for Variables {
	fn var<K>(&self, key: K) -> Option<&str>
	where
		K: AsRef<str>,
	{
		self.inner.get(key.as_ref()).map(|value| value.deref())
	}
}

impl Variables {
	/// Creates a new instance from an iterator over key, value tuples.
	pub fn from_items<K, V, I, II>(iter: II) -> Self
	where
		K: Into<String>,
		V: Into<String>,
		I: Iterator<Item = (K, V)>,
		II: IntoIterator<IntoIter = I, Item = (K, V)>,
	{
		let inner = iter
			.into_iter()
			.map(|(k, v)| (k.into(), v.into()))
			.collect();

		Self { inner }
	}
}