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

//! Defines definitions for a [`Symlink`].

use serde::{Deserialize, Serialize};
use std::path::PathBuf;

/// A symlink to be created during the deployment.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Symlink {
	/// Absolute path of the link source.
	pub source_path: PathBuf,

	/// Absolute path of the link target.
	pub target_path: PathBuf,

	/// Indicates if any existing symlink at the [`Symlink::target_path`] should
	/// be replaced by this item.
	///
	/// # NOTE
	/// It will only replace existing symlink.
	#[serde(default = "default_replace_value")]
	pub replace: bool,
}

/// Provides the default value for [`Symlink::replace`].
const fn default_replace_value() -> bool {
	true
}