nitro_config 0.28.0

Serialization for Nitrolaunch configuration
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

#![warn(missing_docs)]

//! This crate contains serde structs for Nitrolaunch configuration. It does not provide
//! any functionality to actually read the config correctly, just to create it.

use std::{collections::HashMap, sync::Arc};

use instance::InstanceConfig;
use nitro_shared::id::{InstanceID, TemplateID};
use preferences::PrefDeser;
#[cfg(feature = "schema")]
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use template::TemplateConfig;
use user::UserConfig;

/// Instance configuration
pub mod instance;
/// Package configuration
pub mod package;
/// Global preferences configuration
pub mod preferences;
/// Template configuration
pub mod template;
/// User configuration
pub mod user;

/// Deserialization struct for user configuration
#[derive(Deserialize, Serialize, Default)]
#[cfg_attr(feature = "schema", derive(JsonSchema))]
#[serde(default)]
pub struct ConfigDeser {
	/// The list of configured users
	pub users: HashMap<String, UserConfig>,
	/// The currently selected user
	pub default_user: Option<String>,
	/// The list of configured instances
	pub instances: HashMap<InstanceID, InstanceConfig>,
	/// The list of configured instance groups
	pub instance_groups: HashMap<Arc<str>, Vec<InstanceID>>,
	/// The list of configured templates
	#[serde(alias = "profiles")]
	pub templates: HashMap<TemplateID, TemplateConfig>,
	/// The base template
	#[serde(alias = "global_profile")]
	pub base_template: Option<TemplateConfig>,
	/// The global preferences
	pub preferences: PrefDeser,
}