simple-fs 0.12.1

Simple and convenient API for File System access
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

use crate::SPath;
use crate::error::{Cause, PathAndCause};
use crate::safer::{SaferRemoveOptions, support};
use crate::{Error, Result};
use std::fs;

/// Safely deletes a directory if it passes safety checks.
///
/// Safety checks (based on options):
/// - If `restrict_to_current_dir` is true, the directory path must be below the current directory
/// - If `must_contain_any` is set, the path must contain at least one of the specified patterns
/// - If `must_contain_all` is set, the path must contain all of the specified patterns
///
/// Returns Ok(true) if the directory was deleted, Ok(false) if it didn't exist.
/// Returns an error if safety checks fail or deletion fails.
pub fn safer_remove_dir<'a>(dir_path: &SPath, options: impl Into<SaferRemoveOptions<'a>>) -> Result<bool> {
	let options = options.into();

	// If path doesn't exist, just return false
	if !dir_path.exists() {
		return Ok(false);
	}

	let causes = support::check_path_safety_causes(
		dir_path,
		options.restrict_to_current_dir,
		options.must_contain_any,
		options.must_contain_all,
	)?;

	if !causes.is_empty() {
		return Err(Error::DirNotSafeToRemove(PathAndCause {
			path: dir_path.to_string(),
			cause: Cause::Custom(format!("Safety check failed: {}", causes.join("; "))),
		}));
	}

	// Perform the deletion
	fs::remove_dir_all(dir_path.as_std_path()).map_err(|e| {
		Error::DirNotSafeToRemove(PathAndCause {
			path: dir_path.to_string(),
			cause: Cause::Io(Box::new(e)),
		})
	})?;

	Ok(true)
}

/// Safely deletes a file if it passes safety checks.
///
/// Safety checks (based on options):
/// - If `restrict_to_current_dir` is true, the file path must be below the current directory
/// - If `must_contain_any` is set, the path must contain at least one of the specified patterns
/// - If `must_contain_all` is set, the path must contain all of the specified patterns
///
/// Returns Ok(true) if the file was deleted, Ok(false) if it didn't exist.
/// Returns an error if safety checks fail or deletion fails.
pub fn safer_remove_file<'a>(file_path: &SPath, options: impl Into<SaferRemoveOptions<'a>>) -> Result<bool> {
	let options = options.into();

	// If path doesn't exist, just return false
	if !file_path.exists() {
		return Ok(false);
	}

	let causes = support::check_path_safety_causes(
		file_path,
		options.restrict_to_current_dir,
		options.must_contain_any,
		options.must_contain_all,
	)?;

	if !causes.is_empty() {
		return Err(Error::FileNotSafeToRemove(PathAndCause {
			path: file_path.to_string(),
			cause: Cause::Custom(format!("Safety check failed: {}", causes.join("; "))),
		}));
	}

	// Perform the deletion
	fs::remove_file(file_path.as_std_path()).map_err(|e| {
		Error::FileNotSafeToRemove(PathAndCause {
			path: file_path.to_string(),
			cause: Cause::Io(Box::new(e)),
		})
	})?;

	Ok(true)
}

// region:    --- Support
// endregion: --- Support