compress_io 0.6.0

Convenience library for reading and writing compressed files/streams
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

use std::{
	path::{Path, PathBuf},
	ffi::OsStr,
};

use super::compress_type::CompressType;

/// Representation of a filter: an external utility which will be spawned
/// (using [`spawn`]) to filter an input or output stream.
///
/// Users will not normally interact directly with `FilterSpec` unless they are using a custom
/// filter utility rather than those selected automatically by [`CompressIo`].  After creation a
/// `FilterSpec` instance is used to spawn a read or write filter using [`open_read_filter`] or
/// [`open_write_filter`]
///
/// [`open_read_filter`]: crate::compress::open_read_filter
/// [`open_write_filter`]: crate::compress::open_write_filter
/// [`spawn`]: std::process::Command::spawn
///
#[derive(Debug)]
pub struct FilterSpec {
	path: PathBuf,
	args: Vec<Box<OsStr>>,
	compress_type: Option<CompressType>,
}

impl FilterSpec {
	pub fn new<P: AsRef<Path>, I, S>(path: P, args: I) -> Self
	where
		I: IntoIterator<Item = S>,
		S: AsRef<OsStr>, 	 
	{
		let path = path.as_ref().to_owned();
		let args: Vec<_> = args.into_iter().map(|s| Box::from(s.as_ref())).collect();
		Self{path, args, compress_type: None}
	}

	pub(crate) fn new_compress<P: AsRef<Path>, I, S>(path: P, args: I, ctype: CompressType) -> Self
	where
		I: IntoIterator<Item = S>,
		S: AsRef<OsStr>, 	 
	{
		let path = path.as_ref().to_owned();
		let args: Vec<_> = args.into_iter().map(|s| Box::from(s.as_ref())).collect();
		Self{path, args, compress_type: Some(ctype)}
	}
	
	pub(crate) fn cond_add_suffix<P: AsRef<Path>>(&self, name: P) -> PathBuf {
		match self.compress_type {
			Some(ct) => super::path_utils::cond_add_suffix(name, ct.suffix()),
			None => name.as_ref().to_owned()
		}
	}
	
	pub fn compress_type(&self) -> Option<CompressType> { self.compress_type }
	pub fn path(&self) -> &Path { &self.path}
	pub fn args(&self) -> &[Box<OsStr>] { &self.args}
}