vach 0.7.2

A simple archiving format, designed for storing assets in compact secure containers
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
62
63
64

#[cfg(feature = "multithreaded")]
use std::num::NonZeroUsize;

use crate::global::flags::Flags;
#[cfg(feature = "crypto")]
use crate::crypto;

/// Settings for [`dump`](crate::writer::dump)
#[derive(Debug, Clone)]
pub struct BuilderConfig {
	/// Number of threads to spawn during `Builder::dump`, defaults to 4
	#[cfg(feature = "multithreaded")]
	pub num_threads: NonZeroUsize,
	/// Singleton flags to be written into the `Header` section of the archive.
	pub flags: Flags,
	/// An optional private key. If one is provided, then the archive will have signatures.
	#[cfg(feature = "crypto")]
	#[cfg_attr(docsrs, doc(cfg(feature = "crypto")))]
	pub signing_key: Option<crypto::SigningKey>,
}

// Helper functions
impl BuilderConfig {
	/// Setter for the [`num_threads`](BuilderConfig::num_threads) field
	#[cfg(feature = "multithreaded")]
	pub fn threads(mut self, num_threads: usize) -> Self {
		if let Some(n) = NonZeroUsize::new(num_threads) {
			self.num_threads = n;
		}

		self
	}

	/// Setter for the [`keypair`](BuilderConfig::keypair) field
	#[cfg(feature = "crypto")]
	pub fn keypair(mut self, keypair: crypto::SigningKey) -> Self {
		self.signing_key = Some(keypair);
		self
	}

	/// Setter for the [`flags`](BuilderConfig::flags) field
	pub fn flags(mut self, flags: Flags) -> Self {
		self.flags = flags;
		self
	}

	/// Read and parse a keypair from a stream of bytes
	#[cfg(feature = "crypto")]
	pub fn load_keypair<T: std::io::Read>(&mut self, handle: T) -> crate::global::error::InternalResult {
		crate::crypto_utils::read_keypair(handle).map(|kp| self.signing_key = Some(kp))
	}
}

impl<'a> Default for BuilderConfig {
	fn default() -> BuilderConfig {
		BuilderConfig {
			#[cfg(feature = "multithreaded")]
			num_threads: unsafe { NonZeroUsize::new_unchecked(4) },
			flags: Flags::default(),
			#[cfg(feature = "crypto")]
			signing_key: None,
		}
	}
}