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
use crate::;
use TryFrom;
use ;
/// Returns the current working directory as [`PlatformPathBuf`].
///
/// # Errors
///
/// Returns an [`Err`] if the current working directory value is invalid
/// or unable to parse the directory with the platform encoding.
///
/// Possible cases:
///
/// * Current directory does not exist.
/// * There are insufficient permissions to access the current directory.
/// * The encoding used to parse the current directory failed to parse.
///
/// # Examples
///
/// ```
/// fn main() -> std::io::Result<()> {
/// let path = typed_path::utils::current_dir()?;
/// println!("The current directory is {}", path.display());
/// Ok(())
/// }
/// ```
/// Returns the current working directory as [`Utf8PlatformPathBuf`].
///
/// # Errors
///
/// Returns an [`Err`] if the current working directory value is invalid
/// or unable to parse the directory with the platform encoding.
///
/// Possible cases:
///
/// * Current directory does not exist.
/// * There are insufficient permissions to access the current directory.
/// * The encoding used to parse the current directory failed to parse.
/// * The current directory was not valid UTF8.
///
/// # Examples
///
/// ```
/// fn main() -> std::io::Result<()> {
/// let path = typed_path::utils::utf8_current_dir()?;
/// println!("The current directory is {}", path);
/// Ok(())
/// }
/// ```
/// Returns the full filesystem path of the current running executable as [`PlatformPathBuf`].
///
/// # Errors
///
/// Returns an [`Err`] if unable to parse the path with the platform encoding.
///
/// Additionally, returns a [`Err`] if, as [`env::current_exe`] states,
/// a related filesystem operation or syscall fails.
///
///
/// # Examples
///
/// ```
/// fn main() -> std::io::Result<()> {
/// let path = typed_path::utils::current_exe()?;
/// println!("The current executable path is {}", path.display());
/// Ok(())
/// }
/// ```
/// Returns the full filesystem path of the current running executable as [`Utf8PlatformPathBuf`].
///
/// # Errors
///
/// Returns an [`Err`] if unable to parse the path with the platform encoding
/// or the path was not valid UTF8.
///
/// Additionally, returns a [`Err`] if, as [`env::current_exe`] states,
/// a related filesystem operation or syscall fails.
///
///
/// # Examples
///
/// ```
/// fn main() -> std::io::Result<()> {
/// let path = typed_path::utils::utf8_current_exe()?;
/// println!("The current executable path is {}", path);
/// Ok(())
/// }
/// ```
/// Returns the path of a temporary directory as [`PlatformPathBuf`].
///
/// # Errors
///
/// Returns an [`Err`] if unable to parse the path with the platform encoding.
///
///
/// # Examples
///
/// ```
/// fn main() -> std::io::Result<()> {
/// let path = typed_path::utils::temp_dir()?;
/// println!("The temporary directory path is {}", path.display());
/// Ok(())
/// }
/// ```
/// Returns the path of a temporary directory as [`Utf8PlatformPathBuf`].
///
/// # Errors
///
/// Returns an [`Err`] if unable to parse the path with the platform encoding
/// or the path was not valid UTF8.
///
///
/// # Examples
///
/// ```
/// fn main() -> std::io::Result<()> {
/// let path = typed_path::utils::utf8_temp_dir()?;
/// println!("The temporary directory path is {}", path);
/// Ok(())
/// }
/// ```