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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
use crate::{CowStr, FsUtils};
use async_recursion::async_recursion;
use file_format::FileFormat;
use smol::{
fs::{read_dir, ReadDir},
io::{self, ErrorKind},
stream::StreamExt,
unblock,
};
use std::{
borrow::Cow,
path::{Path, PathBuf},
};
use tai64::Tai64N;
#[cfg(feature = "time")]
use crate::DateTimeString;
/// The Metadata of all directories and files in the current directory
/// #### Example
/// ```rust
/// use dir_meta::DirMetadata;
///
/// let dir = DirMetadata::new("/path/to/directory").dir_metadata();
/// ```
#[derive(Debug, PartialEq, Eq, Default, Clone)]
pub struct DirMetadata<'a> {
name: CowStr<'a>,
path: PathBuf,
directories: Vec<PathBuf>,
files: Vec<FileMetadata<'a>>,
size: usize,
errors: Vec<DirError<'a>>,
}
impl<'a> DirMetadata<'a> {
/// Create a new instance of [Self]
pub fn new(path: &'a str) -> Self {
let dir_name: PathBuf = path.into();
let dir_name = dir_name.file_name();
let name = match dir_name {
Some(name) => CowStr::Owned(name.to_string_lossy().to_string()),
None => path.into(),
};
DirMetadata {
path: path.into(),
name,
..Default::default()
}
}
/// Returns an error if the directory cannot be accessed
/// Read all the directories and files in the given path
pub async fn dir_metadata(mut self) -> Result<DirMetadata<'a>, io::Error> {
let mut dir = read_dir(&self.path).await?;
self.iter_dir(&mut dir).await;
Ok(self)
}
/// Recursively iterate over directories inside directories
#[async_recursion]
pub async fn iter_dir(&mut self, prepared_dir: &mut ReadDir) -> &mut Self {
let mut directories = Vec::<PathBuf>::new();
while let Some(entry_result) = prepared_dir.next().await {
match entry_result {
Err(error) => {
self.errors.push(DirError {
path: self.path.clone(),
error: error.kind(),
display: error.to_string().into(),
});
}
Ok(entry) => {
let mut is_dir = false;
match entry.file_type().await {
Ok(file_type) => is_dir = file_type.is_dir(),
Err(error) => {
let inner_path = entry.path();
self.errors.push(DirError {
path: inner_path.clone(),
error: error.kind(),
display: Cow::Owned(format!(
"Unable to check if `{}` is a directory",
inner_path.display()
)),
});
}
}
if is_dir {
directories.push(entry.path())
} else {
let mut file_meta = FileMetadata::default();
let cloned_path = entry.path().clone();
let get_file_format = unblock(move || FileFormat::from_file(cloned_path));
let format = match get_file_format.await {
Ok(format_detected) => format_detected,
Err(_) => FileFormat::default(),
};
file_meta.file_format = format;
file_meta.name =
CowStr::Owned(entry.file_name().to_string_lossy().to_string());
file_meta.path = entry.path();
match entry.metadata().await {
Ok(meta) => {
let current_file_size = meta.len() as usize;
self.size += current_file_size;
file_meta.size = current_file_size;
file_meta.accessed = FsUtils::maybe_time(meta.accessed().ok());
file_meta.modified = FsUtils::maybe_time(meta.modified().ok());
file_meta.created = FsUtils::maybe_time(meta.created().ok());
}
Err(error) => {
self.errors.push(DirError {
path: entry.path(),
error: error.kind(),
display: Cow::Owned(format!(
"Unable to access metadata of file `{}`",
entry.path().display()
)),
});
}
}
self.files.push(file_meta);
}
}
}
}
let mut dir_iter = smol::stream::iter(&directories);
while let Some(path) = dir_iter.next().await {
match read_dir(path.clone()).await {
Ok(mut prepared_dir) => {
self.iter_dir(&mut prepared_dir).await;
}
Err(error) => self.errors.push(DirError {
path: path.to_owned(),
error: error.kind(),
display: Cow::Owned(format!(
"Unable to access metadata of file `{}`",
path.display()
)),
}),
}
}
self.directories.extend_from_slice(&directories);
self
}
/// Get the name of the current directory
pub fn dir_name(&self) -> &str {
self.name.as_ref()
}
/// Get the path of the current directory
pub fn dir_path(&self) -> &Path {
self.path.as_ref()
}
/// Get all the sub-directories of the current directory
pub fn directories(&self) -> &[PathBuf] {
self.directories.as_ref()
}
/// Get all the files in the current directory and all the files in it's sub-directory
pub fn files(&self) -> &[FileMetadata<'a>] {
self.files.as_ref()
}
/// Get the size of the directory including the size of all files in the sub-directories
pub fn size(&self) -> usize {
self.size
}
/// Get the size of the directory including the size of all files in the sub-directories in human readable format
pub fn size_formatted(&self) -> String {
FsUtils::size_to_bytes(self.size)
}
/// Get all the errors encountered while opening the sub-directories and files
pub fn errors(&self) -> &[DirError<'a>] {
self.errors.as_ref()
}
}
/// The file metadata like file name, file type, file size, file path etc
#[derive(Debug, PartialEq, Eq, Default, Clone)]
pub struct FileMetadata<'a> {
name: CowStr<'a>,
path: PathBuf,
size: usize,
read_only: bool,
created: Option<Tai64N>,
accessed: Option<Tai64N>,
modified: Option<Tai64N>,
symlink: bool,
file_format: FileFormat,
}
impl<'a> FileMetadata<'a> {
/// Get the name of the file
pub fn name(&self) -> &str {
self.name.as_ref()
}
/// Get the path of the file
pub fn path(&self) -> &Path {
self.path.as_ref()
}
/// Get the size of the file
pub fn size(&self) -> usize {
self.size
}
/// Get the size of the file in human readable format
pub fn formatted_size(&self) -> String {
FsUtils::size_to_bytes(self.size)
}
/// Get the TAI64N timestamp when the file was last accessed
pub fn accessed(&self) -> Option<Tai64N> {
self.accessed
}
/// Get the TAI64N timestamp when the file was last modified
pub fn modified(&self) -> Option<Tai64N> {
self.modified
}
/// Get the TAI64N timestamp when the file was last created
pub fn created(&self) -> Option<Tai64N> {
self.created
}
/// Get the timestamp in local time in 24 hour format when the file was last accessed
#[cfg(feature = "time")]
pub fn accessed_24hr(&self) -> Option<DateTimeString<'a>> {
Some(FsUtils::tai64_to_local_hrs(&self.accessed?))
}
/// Get the timestamp in local time in 12 hour format when the file was last accessed
#[cfg(feature = "time")]
pub fn accessed_am_pm(&self) -> Option<DateTimeString<'a>> {
Some(FsUtils::tai64_to_local_am_pm(&self.accessed?))
}
/// Get the time passed since access of a file eg `3 sec ago`
#[cfg(feature = "time")]
pub fn accessed_humatime(&self) -> Option<String> {
FsUtils::tai64_now_duration_to_humantime(&self.accessed?)
}
/// Get the timestamp in local time in 24 hour format when the file was last modified
#[cfg(feature = "time")]
pub fn modified_24hr(&self) -> Option<DateTimeString<'a>> {
Some(FsUtils::tai64_to_local_hrs(&self.modified?))
}
/// Get the timestamp in local time in 12 hour format when the file was last modified
#[cfg(feature = "time")]
pub fn modified_am_pm(&self) -> Option<DateTimeString<'a>> {
Some(FsUtils::tai64_to_local_am_pm(&self.modified?))
}
/// Get the time passed since modification of a file eg `3 sec ago`
#[cfg(feature = "time")]
pub fn modified_humatime(&self) -> Option<String> {
FsUtils::tai64_now_duration_to_humantime(&self.modified?)
}
/// Get the timestamp in local time in 24 hour format when the file was created
#[cfg(feature = "time")]
pub fn created_24hr(&self) -> Option<DateTimeString<'a>> {
Some(FsUtils::tai64_to_local_hrs(&self.created?))
}
/// Get the timestamp in local time in 12 hour format when the file was created
#[cfg(feature = "time")]
pub fn created_am_pm(&self) -> Option<DateTimeString<'a>> {
Some(FsUtils::tai64_to_local_am_pm(&self.created?))
}
/// Get the time passed since file was created of a file eg `3 sec ago`
#[cfg(feature = "time")]
pub fn created_humatime(&self) -> Option<String> {
FsUtils::tai64_now_duration_to_humantime(&self.created?)
}
/// Is the file read only
pub fn read_only(&self) -> bool {
self.read_only
}
/// Is the file a symbolic link
pub fn symlink(&self) -> bool {
self.symlink
}
/// Get the format of the current file
pub fn file_format(&self) -> &FileFormat {
&self.file_format
}
}
/// An error encountered while accessing a file or sub-directory
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone)]
pub struct DirError<'a> {
/// The path to the sub-directory or file where the error occurred
pub path: PathBuf,
/// The kind of error that occurred based on [std::io::ErrorKind]
pub error: ErrorKind,
/// The formatted error as a [String]
pub display: CowStr<'a>,
}