live 0.3.1

A modular configuration framework with live reloading and atomic, format-agnostic updates.
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

/* src/holder/store/read.rs */

use std::collections::HashMap;
use std::sync::Arc;

#[cfg(feature = "events")]
use super::super::HoldEvent;
use super::super::{Entry, Meta};
use super::Store;

impl<T> Store<T>
where
	T: Clone + Send + Sync,
{
	/// Gets a config value by key. This is a wait-free operation.
	pub fn get(&self, key: &str) -> Option<Arc<T>> {
		let snapshot = self.inner.load();
		snapshot.get(key).map(|entry| Arc::clone(&entry.value))
	}

	/// Gets metadata for a config by key.
	pub fn get_meta(&self, key: &str) -> Option<Meta> {
		let snapshot = self.inner.load();
		snapshot.get(key).map(|entry| entry.meta.clone())
	}

	/// Gets the full entry (value + metadata) by key.
	pub fn get_entry(&self, key: &str) -> Option<Entry<T>> {
		let snapshot = self.inner.load();
		snapshot.get(key).cloned()
	}

	/// Returns an atomic snapshot of all entries.
	pub fn snapshot(&self) -> Arc<HashMap<String, Entry<T>>> {
		self.inner.load_full()
	}

	/// Returns all keys in the store.
	pub fn keys(&self) -> Vec<String> {
		let snapshot = self.inner.load();
		snapshot.keys().cloned().collect()
	}

	/// Returns the number of entries.
	pub fn len(&self) -> usize {
		let snapshot = self.inner.load();
		snapshot.len()
	}

	/// Returns true if the store is empty.
	pub fn is_empty(&self) -> bool {
		let snapshot = self.inner.load();
		snapshot.is_empty()
	}

	/// Subscribes to store change events.
	#[cfg(feature = "events")]
	pub fn subscribe(&self) -> tokio::sync::broadcast::Receiver<HoldEvent<T>> {
		self.events.subscribe()
	}
}