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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
//! Filesystem I/O methods for `VirtualPath`.
//!
//! All methods delegate to the inner `StrictPath`, which holds the real system path. The
//! virtual path component is not used for I/O — it exists only for user-visible display.
use super::VirtualPath;
impl<Marker> VirtualPath<Marker> {
/// Write bytes to the underlying system path. Accepts `&str`, `String`, `&[u8]`, `Vec<u8]`, etc.
#[inline]
pub fn write<C: AsRef<[u8]>>(&self, contents: C) -> std::io::Result<()> {
self.inner.write(contents)
}
/// Append bytes to the underlying system path (create if missing). Accepts `&str`, `&[u8]`, etc.
///
/// # Errors
///
/// - `std::io::Error`: Propagates OS errors when the file cannot be opened or written.
///
/// # Examples
///
/// ```rust
/// # use strict_path::VirtualRoot;
/// # let root = std::env::temp_dir().join("strict-path-vpath-append");
/// # std::fs::create_dir_all(&root)?;
/// # let vroot: VirtualRoot = VirtualRoot::try_new(&root)?;
/// // Untrusted input from request/CLI/config/etc.
/// let log_file = "logs/activity.log";
/// let vpath = vroot.virtual_join(log_file)?;
/// vpath.create_parent_dir_all()?;
/// vpath.append("[2025-01-01] Operation A\n")?;
/// vpath.append("[2025-01-01] Operation B\n")?;
/// let contents = vpath.read_to_string()?;
/// assert!(contents.contains("Operation A"));
/// assert!(contents.contains("Operation B"));
/// # std::fs::remove_dir_all(&root)?;
/// # Ok::<_, Box<dyn std::error::Error>>(())
/// ```
#[inline]
pub fn append<C: AsRef<[u8]>>(&self, data: C) -> std::io::Result<()> {
self.inner.append(data)
}
/// Create or truncate the file at this virtual path and return a writable handle.
///
/// # Errors
///
/// - `std::io::Error`: Propagates operating-system errors when the parent directory is missing or file creation fails.
///
/// # Examples
///
/// ```rust
/// # use strict_path::VirtualRoot;
/// # use std::io::Write;
/// # let root = std::env::temp_dir().join("strict-path-virtual-create-file");
/// # std::fs::create_dir_all(&root)?;
/// # let vroot: VirtualRoot = VirtualRoot::try_new(&root)?;
/// let report = vroot.virtual_join("reports/summary.txt")?;
/// report.create_parent_dir_all()?;
/// let mut file = report.create_file()?;
/// file.write_all(b"summary")?;
/// # std::fs::remove_dir_all(&root)?;
/// # Ok::<_, Box<dyn std::error::Error>>(())
/// ```
#[inline]
pub fn create_file(&self) -> std::io::Result<std::fs::File> {
self.inner.create_file()
}
/// Open the file at this virtual path in read-only mode.
///
/// # Errors
///
/// - `std::io::Error`: Propagates operating-system errors when the file is missing or inaccessible.
///
/// # Examples
///
/// ```rust
/// # use strict_path::VirtualRoot;
/// # use std::io::{Read, Write};
/// # let root = std::env::temp_dir().join("strict-path-virtual-open-file");
/// # std::fs::create_dir_all(&root)?;
/// # let vroot: VirtualRoot = VirtualRoot::try_new(&root)?;
/// let report = vroot.virtual_join("reports/summary.txt")?;
/// report.create_parent_dir_all()?;
/// report.write("summary")?;
/// let mut file = report.open_file()?;
/// let mut contents = String::new();
/// file.read_to_string(&mut contents)?;
/// assert_eq!(contents, "summary");
/// # std::fs::remove_dir_all(&root)?;
/// # Ok::<_, Box<dyn std::error::Error>>(())
/// ```
#[inline]
pub fn open_file(&self) -> std::io::Result<std::fs::File> {
self.inner.open_file()
}
/// Return an options builder for advanced file opening (read+write, append, exclusive create, etc.).
///
/// # Examples
///
/// ```rust
/// # use strict_path::VirtualRoot;
/// # use std::io::{Read, Write, Seek, SeekFrom};
/// # let root = std::env::temp_dir().join("vpath-open-with-example");
/// # std::fs::create_dir_all(&root)?;
/// # let vroot: VirtualRoot = VirtualRoot::try_new(&root)?;
/// // Untrusted input from request/CLI/config/etc.
/// let data_file = "cache/state.bin";
/// let cache_path = vroot.virtual_join(data_file)?;
/// cache_path.create_parent_dir_all()?;
///
/// // Open with read+write access, create if missing
/// let mut file = cache_path.open_with()
/// .read(true)
/// .write(true)
/// .create(true)
/// .open()?;
/// file.write_all(b"state")?;
/// file.seek(SeekFrom::Start(0))?;
/// let mut buf = [0u8; 5];
/// file.read_exact(&mut buf)?;
/// assert_eq!(&buf, b"state");
/// # std::fs::remove_dir_all(&root)?;
/// # Ok::<_, Box<dyn std::error::Error>>(())
/// ```
#[must_use = "open_with() returns a builder — chain .read(), .write(), .create(), .open() to use it"]
#[inline]
pub fn open_with(&self) -> crate::path::strict_path::StrictOpenOptions<'_, Marker> {
self.inner.open_with()
}
/// Create all directories in the underlying system path if missing.
#[inline]
pub fn create_dir_all(&self) -> std::io::Result<()> {
self.inner.create_dir_all()
}
/// Create the directory at this virtual location (non‑recursive). Fails if parent missing.
#[inline]
pub fn create_dir(&self) -> std::io::Result<()> {
self.inner.create_dir()
}
/// Create only the immediate parent of this virtual path (non‑recursive). `Ok(())` at virtual root.
#[inline]
pub fn create_parent_dir(&self) -> std::io::Result<()> {
match self.virtualpath_parent() {
Ok(Some(parent)) => parent.create_dir(),
Ok(None) => Ok(()),
Err(crate::StrictPathError::PathEscapesBoundary { .. }) => Ok(()),
Err(e) => Err(std::io::Error::other(e)),
}
}
/// Recursively create all missing directories up to the immediate parent. `Ok(())` at virtual root.
#[inline]
pub fn create_parent_dir_all(&self) -> std::io::Result<()> {
match self.virtualpath_parent() {
Ok(Some(parent)) => parent.create_dir_all(),
Ok(None) => Ok(()),
Err(crate::StrictPathError::PathEscapesBoundary { .. }) => Ok(()),
Err(e) => Err(std::io::Error::other(e)),
}
}
/// Remove the file at the underlying system path.
#[inline]
pub fn remove_file(&self) -> std::io::Result<()> {
self.inner.remove_file()
}
/// Remove the directory at the underlying system path.
#[inline]
pub fn remove_dir(&self) -> std::io::Result<()> {
self.inner.remove_dir()
}
/// Recursively remove the directory and its contents at the underlying system path.
#[inline]
pub fn remove_dir_all(&self) -> std::io::Result<()> {
self.inner.remove_dir_all()
}
}