fs_extra/dir.rs
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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
use crate::error::*;
use std::collections::{HashMap, HashSet};
use std::fs::{create_dir, create_dir_all, read_dir, remove_dir_all, Metadata};
use std::path::{Path, PathBuf};
use std::time::SystemTime;
/// Options and flags which can be used to configure how a file will be copied or moved.
#[derive(Clone)]
pub struct CopyOptions {
/// Overwrite existing files if true (default: false).
pub overwrite: bool,
/// Skip existing files if true (default: false).
pub skip_exist: bool,
/// Buffer size that specifies the amount of bytes to be moved or copied before the progress handler is called. This only affects functions with progress handlers. (default: 64000)
pub buffer_size: usize,
/// Recursively copy a directory with a new name or place it inside the destination (default: false, same behaviors as cp -r on Unix)
pub copy_inside: bool,
/// Copy only contents without a creating a new folder in the destination folder (default: false).
pub content_only: bool,
/// Sets levels reading. Set 0 for read all directory folder (default: 0).
///
/// Warning: Work only for copy operations!
pub depth: u64,
}
impl CopyOptions {
/// Initialize struct CopyOptions with default value.
///
/// ```rust,ignore
/// overwrite: false
///
/// skip_exist: false
///
/// buffer_size: 64000 // 64kb
///
/// copy_inside: false
/// ```
pub fn new() -> CopyOptions {
CopyOptions {
overwrite: false,
skip_exist: false,
buffer_size: 64000, // 64kb
copy_inside: false,
content_only: false,
depth: 0,
}
}
/// Overwrite existing files if true.
pub fn overwrite(mut self, overwrite: bool) -> Self {
self.overwrite = overwrite;
self
}
/// Skip existing files if true.
pub fn skip_exist(mut self, skip_exist: bool) -> Self {
self.skip_exist = skip_exist;
self
}
/// Buffer size that specifies the amount of bytes to be moved or copied before the progress handler is called. This only affects functions with progress handlers.
pub fn buffer_size(mut self, buffer_size: usize) -> Self {
self.buffer_size = buffer_size;
self
}
/// Recursively copy a directory with a new name or place it inside the destination (default: false, same behaviors as cp -r on Unix)
pub fn copy_inside(mut self, copy_inside: bool) -> Self {
self.copy_inside = copy_inside;
self
}
/// Copy only contents without a creating a new folder in the destination folder.
pub fn content_only(mut self, content_only: bool) -> Self {
self.content_only = content_only;
self
}
/// Sets levels reading. Set 0 for read all directory folder
pub fn depth(mut self, depth: u64) -> Self {
self.depth = depth;
self
}
}
impl Default for CopyOptions {
fn default() -> Self {
CopyOptions::new()
}
}
// Options and flags which can be used to configure how to read a directory.
#[derive(Clone, Default)]
pub struct DirOptions {
/// Sets levels reading. Set value 0 for read all directory folder. By default 0.
pub depth: u64,
}
impl DirOptions {
/// Initialize struct DirOptions with default value.
pub fn new() -> DirOptions {
Default::default()
}
}
/// A structure which include information about directory
pub struct DirContent {
/// Directory size in bytes.
pub dir_size: u64,
/// List all files directory and sub directories.
pub files: Vec<String>,
/// List all folders and sub folders directory.
pub directories: Vec<String>,
}
/// A structure which include information about the current status of the copy or move directory.
pub struct TransitProcess {
/// Copied bytes on this time for folder
pub copied_bytes: u64,
/// All the bytes which should to copy or move (dir size).
pub total_bytes: u64,
/// Copied bytes on this time for file.
pub file_bytes_copied: u64,
/// Size current copied file.
pub file_total_bytes: u64,
/// Name current copied file.
pub file_name: String,
/// Transit state
pub state: TransitState,
}
///
#[derive(Hash, Eq, PartialEq, Clone)]
pub enum TransitState {
/// Standard state.
Normal,
/// Pause state when destination path exists.
Exists,
/// Pause state when current process does not have the permission to access from or to
/// path.
NoAccess,
}
/// Available returns codes for user decide
pub enum TransitProcessResult {
/// Rewrite exist file or directory.
Overwrite,
/// Rewrite for all exist files or directories.
OverwriteAll,
/// Skip current problem file or directory.
Skip,
/// Skip for all problems file or directory.
SkipAll,
/// Retry current operation.
Retry,
/// Abort current operation.
Abort,
/// Continue execute process if process not have error and abort if process content error.
ContinueOrAbort,
}
impl Clone for TransitProcess {
fn clone(&self) -> TransitProcess {
TransitProcess {
copied_bytes: self.copied_bytes,
total_bytes: self.total_bytes,
file_bytes_copied: self.file_bytes_copied,
file_total_bytes: self.file_total_bytes,
file_name: self.file_name.clone(),
state: self.state.clone(),
}
}
}
/// Available attributes for get information about directory entry.
#[derive(Hash, Eq, PartialEq, Clone)]
pub enum DirEntryAttr {
/// Folder name or file name without extension.
Name,
/// File extension.
Ext,
/// Folder name or file name with extension.
FullName,
/// Path to file or directory.
Path,
/// Dos path to file or directory.
DosPath,
/// File size in bytes.
FileSize,
/// Size file or directory in bytes.
///
/// `Attention!`: This operation very expensive and sometimes required additional rights.
Size,
/// Return whether entry is directory or not.
IsDir,
/// Return whether entry is file or not.
IsFile,
/// Last modification time for directory entry.
Modified,
/// Last access time for directory entry.
Accessed,
/// Created time for directory entry.
///
/// `Attention!`: Not supported UNIX platform.
Created,
/// Return or not return base information target folder.
BaseInfo,
}
/// Available types for directory entry.
pub enum DirEntryValue {
/// String type
String(String),
/// Boolean type
Boolean(bool),
/// SystemTime type
SystemTime(SystemTime),
/// u64 type
U64(u64),
}
/// Result returned by the `ls` function.
pub struct LsResult {
/// Base folder target path
pub base: HashMap<DirEntryAttr, DirEntryValue>,
/// Collection directory entry with information.
pub items: Vec<HashMap<DirEntryAttr, DirEntryValue>>,
}
/// Returned information about directory entry with information which you choose in config.
///
/// This function takes to arguments:
///
/// * `path` - Path to directory.
///
/// * `config` - Set attributes which you want see inside return data.
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `path` does not exist.
/// * Invalid `path`.
/// * The current process does not have the permission to access `path`.
///
/// #Examples
///
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::{get_details_entry, DirEntryAttr};
/// use std::collections::{HashMap, HashSet};
///
/// let mut config = HashSet::new();
/// config.insert(DirEntryAttr::Name);
/// config.insert(DirEntryAttr::Size);
///
/// let entry_info = get_details_entry("test", &config);
/// assert_eq!(2, entry_info.len());
/// ```
pub fn get_details_entry<P>(
path: P,
config: &HashSet<DirEntryAttr>,
) -> Result<HashMap<DirEntryAttr, DirEntryValue>>
where
P: AsRef<Path>,
{
let path = path.as_ref();
let metadata = path.metadata()?;
get_details_entry_with_meta(path, config, metadata)
}
fn get_details_entry_with_meta<P>(
path: P,
config: &HashSet<DirEntryAttr>,
metadata: Metadata,
) -> Result<HashMap<DirEntryAttr, DirEntryValue>>
where
P: AsRef<Path>,
{
let path = path.as_ref();
let mut item = HashMap::new();
if config.contains(&DirEntryAttr::Name) {
if metadata.is_dir() {
if let Some(file_name) = path.file_name() {
item.insert(
DirEntryAttr::Name,
DirEntryValue::String(file_name.to_os_string().into_string()?),
);
} else {
item.insert(DirEntryAttr::Name, DirEntryValue::String(String::new()));
}
} else if let Some(file_stem) = path.file_stem() {
item.insert(
DirEntryAttr::Name,
DirEntryValue::String(file_stem.to_os_string().into_string()?),
);
} else {
item.insert(DirEntryAttr::Name, DirEntryValue::String(String::new()));
}
}
if config.contains(&DirEntryAttr::Ext) {
if let Some(value) = path.extension() {
item.insert(
DirEntryAttr::Ext,
DirEntryValue::String(value.to_os_string().into_string()?),
);
} else {
item.insert(DirEntryAttr::Ext, DirEntryValue::String(String::from("")));
}
}
if config.contains(&DirEntryAttr::FullName) {
if let Some(file_name) = path.file_name() {
item.insert(
DirEntryAttr::FullName,
DirEntryValue::String(file_name.to_os_string().into_string()?),
);
} else {
item.insert(DirEntryAttr::FullName, DirEntryValue::String(String::new()));
}
}
if config.contains(&DirEntryAttr::Path) {
let mut result_path: PathBuf;
match path.canonicalize() {
Ok(new_path) => {
result_path = new_path;
}
Err(_) => {
if let Some(parent_path) = path.parent() {
if let Some(name) = path.file_name() {
result_path = parent_path.canonicalize()?;
result_path.push(name);
} else {
err!("Error get part name path", ErrorKind::Other);
}
} else {
err!("Error get parent path", ErrorKind::Other);
}
}
}
let mut path = result_path.as_os_str().to_os_string().into_string()?;
if path.find("\\\\?\\") == Some(0) {
path = path[4..].to_string();
}
item.insert(DirEntryAttr::Path, DirEntryValue::String(path));
}
if config.contains(&DirEntryAttr::DosPath) {
let mut result_path: PathBuf;
match path.canonicalize() {
Ok(new_path) => {
result_path = new_path;
}
Err(_) => {
if let Some(parent_path) = path.parent() {
if let Some(name) = path.file_name() {
result_path = parent_path.canonicalize()?;
result_path.push(name);
} else {
err!("Error get part name path", ErrorKind::Other);
}
} else {
err!("Error get parent path", ErrorKind::Other);
}
}
}
let path = result_path.as_os_str().to_os_string().into_string()?;
item.insert(DirEntryAttr::DosPath, DirEntryValue::String(path));
}
if config.contains(&DirEntryAttr::Size) {
item.insert(DirEntryAttr::Size, DirEntryValue::U64(get_size(&path)?));
}
if config.contains(&DirEntryAttr::FileSize) {
item.insert(DirEntryAttr::FileSize, DirEntryValue::U64(metadata.len()));
}
if config.contains(&DirEntryAttr::IsDir) {
item.insert(
DirEntryAttr::IsDir,
DirEntryValue::Boolean(metadata.is_dir()),
);
}
if config.contains(&DirEntryAttr::IsFile) {
item.insert(
DirEntryAttr::IsFile,
DirEntryValue::Boolean(metadata.is_file()),
);
}
if config.contains(&DirEntryAttr::Modified) {
item.insert(
DirEntryAttr::Modified,
DirEntryValue::SystemTime(metadata.modified()?),
);
}
if config.contains(&DirEntryAttr::Accessed) {
item.insert(
DirEntryAttr::Accessed,
DirEntryValue::SystemTime(metadata.accessed()?),
);
}
if config.contains(&DirEntryAttr::Created) {
item.insert(
DirEntryAttr::Created,
DirEntryValue::SystemTime(metadata.created()?),
);
}
Ok(item)
}
/// Returns a collection of directory entries with attributes specifying the information that should be returned.
///
/// This function takes to arguments:
///
/// * `path` - Path to directory.
///
/// * `config` - Set attributes which you want see in return data.
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `path` directory does not exist.
/// * Invalid `path`.
/// * The current process does not have the permission to access `path`.
///
/// #Examples
///
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::{ls, DirEntryAttr, LsResult};
/// use std::collections::HashSet;
///
/// let mut config = HashSet::new();
/// config.insert(DirEntryAttr::Name);
/// config.insert(DirEntryAttr::Size);
/// config.insert(DirEntryAttr::BaseInfo);
///
/// let result = ls("test", &config);
/// assert_eq!(2, ls_result.items.len());
/// assert_eq!(2, ls_result.base.len());
/// ```
pub fn ls<P>(path: P, config: &HashSet<DirEntryAttr>) -> Result<LsResult>
where
P: AsRef<Path>,
{
let mut items = Vec::new();
let path = path.as_ref();
if !path.is_dir() {
err!("Path does not directory", ErrorKind::InvalidFolder);
}
for entry in read_dir(&path)? {
let entry = entry?;
let path = entry.path();
let metadata = entry.metadata()?;
let item = get_details_entry_with_meta(path, &config, metadata)?;
items.push(item);
}
let mut base = HashMap::new();
if config.contains(&DirEntryAttr::BaseInfo) {
base = get_details_entry(&path, &config)?;
}
Ok(LsResult { items, base })
}
/// Creates a new, empty directory at the provided path.
///
/// This function takes to arguments:
///
/// * `path` - Path to new directory.
///
/// * `erase` - If set true and folder exist, then folder will be erased.
///
/// #Errors
///
/// This function will return an error in the following situations,
/// but is not limited to just these cases:
///
/// * User lacks permissions to create directory at `path`.
///
/// * `path` already exists if `erase` set false.
///
/// #Examples
///
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::create;
///
/// create("dir", false); // create directory
/// ```
pub fn create<P>(path: P, erase: bool) -> Result<()>
where
P: AsRef<Path>,
{
if erase && path.as_ref().exists() {
remove(&path)?;
}
Ok(create_dir(&path)?)
}
/// Recursively create a directory and all of its parent components if they are missing.
///
/// This function takes to arguments:
///
/// * `path` - Path to new directory.
///
/// * `erase` - If set true and folder exist, then folder will be erased.
///
///#Errors
///
/// This function will return an error in the following situations,
/// but is not limited to just these cases:
///
/// * User lacks permissions to create directory at `path`.
///
/// * `path` already exists if `erase` set false.
///
/// #Examples
///
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::create_all;
///
/// create_all("/some/dir", false); // create directory some and dir
pub fn create_all<P>(path: P, erase: bool) -> Result<()>
where
P: AsRef<Path>,
{
if erase && path.as_ref().exists() {
remove(&path)?;
}
Ok(create_dir_all(&path)?)
}
/// Copies the directory contents from one place to another using recursive method.
/// This function will also copy the permission bits of the original files to
/// destination files (not for directories).
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `from` path is not a directory.
/// * This `from` directory does not exist.
/// * Invalid folder name for `from` or `to`.
/// * The current process does not have the permission to access `from` or write `to`.
///
/// # Example
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::copy;
///
/// let options = CopyOptions::new(); //Initialize default values for CopyOptions
/// // options.mirror_copy = true; // To mirror copy the whole structure of the source directory
///
///
/// // copy source/dir1 to target/dir1
/// copy("source/dir1", "target/dir1", &options)?;
///
/// ```
pub fn copy<P, Q>(from: P, to: Q, options: &CopyOptions) -> Result<u64>
where
P: AsRef<Path>,
Q: AsRef<Path>,
{
let from = from.as_ref();
if !from.exists() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" does not exist or you don't have access!", msg);
err!(&msg, ErrorKind::NotFound);
}
err!(
"Path does not exist Or you don't have access!",
ErrorKind::NotFound
);
}
if !from.is_dir() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" is not a directory!", msg);
err!(&msg, ErrorKind::InvalidFolder);
}
err!("Path is not a directory!", ErrorKind::InvalidFolder);
}
let dir_name;
if let Some(val) = from.components().last() {
dir_name = val.as_os_str();
} else {
err!("Invalid folder from", ErrorKind::InvalidFolder);
}
let mut to: PathBuf = to.as_ref().to_path_buf();
if (to.exists() || !options.copy_inside) && !options.content_only {
to.push(dir_name);
}
let mut read_options = DirOptions::new();
if options.depth > 0 {
read_options.depth = options.depth;
}
let dir_content = get_dir_content2(from, &read_options)?;
for directory in dir_content.directories {
let tmp_to = Path::new(&directory).strip_prefix(from)?;
let dir = to.join(&tmp_to);
if !dir.exists() {
if options.copy_inside {
create_all(dir, false)?;
} else {
create(dir, false)?;
}
}
}
let mut result: u64 = 0;
for file in dir_content.files {
let to = to.to_path_buf();
let tp = Path::new(&file).strip_prefix(from)?;
let path = to.join(&tp);
let file_options = super::file::CopyOptions {
overwrite: options.overwrite,
skip_exist: options.skip_exist,
buffer_size: options.buffer_size,
};
let mut result_copy: Result<u64>;
let mut work = true;
while work {
result_copy = super::file::copy(&file, &path, &file_options);
match result_copy {
Ok(val) => {
result += val;
work = false;
}
Err(err) => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
}
}
}
Ok(result)
}
/// Return DirContent which contains information about directory:
///
/// * Size of the directory in bytes.
/// * List of source paths of files in the directory (files inside subdirectories included too).
/// * List of source paths of all directories and subdirectories.
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `path` directory does not exist.
/// * Invalid `path`.
/// * The current process does not have the permission to access `path`.
///
/// # Examples
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::get_dir_content;
///
/// let dir_content = get_dir_content("dir")?;
/// for directory in dir_content.directories {
/// println!("{}", directory); // print directory path
/// }
/// ```
///
pub fn get_dir_content<P>(path: P) -> Result<DirContent>
where
P: AsRef<Path>,
{
let options = DirOptions::new();
get_dir_content2(path, &options)
}
/// Return DirContent which contains information about directory:
///
/// * Size directory.
/// * List all files source directory(files subdirectories included too).
/// * List all directory and subdirectories source path.
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `path` directory does not exist.
/// * Invalid `path`.
/// * The current process does not have the permission to access `path`.
///
/// # Examples
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::{DirOptions, get_dir_content2};
///
/// let mut options = DirOptions::new();
/// options.depth = 3; // Get 3 levels of folder.
/// let dir_content = get_dir_content2("dir", &options)?;
/// for directory in dir_content.directories {
/// println!("{}", directory); // print directory path
/// }
/// ```
///
pub fn get_dir_content2<P>(path: P, options: &DirOptions) -> Result<DirContent>
where
P: AsRef<Path>,
{
let mut depth = 0;
if options.depth != 0 {
depth = options.depth + 1;
}
_get_dir_content(path, depth)
}
fn _get_dir_content<P>(path: P, mut depth: u64) -> Result<DirContent>
where
P: AsRef<Path>,
{
let mut directories = Vec::new();
let mut files = Vec::new();
let mut dir_size;
let item = path.as_ref().to_str();
if item.is_none() {
err!("Invalid path", ErrorKind::InvalidPath);
}
let item = item.unwrap().to_string();
if path.as_ref().is_dir() {
dir_size = path.as_ref().metadata()?.len();
directories.push(item);
if depth == 0 || depth > 1 {
if depth > 1 {
depth -= 1;
}
for entry in read_dir(&path)? {
let _path = entry?.path();
match _get_dir_content(_path, depth) {
Ok(items) => {
let mut _files = items.files;
let mut _directories = items.directories;
dir_size += items.dir_size;
files.append(&mut _files);
directories.append(&mut _directories);
}
Err(err) => return Err(err),
}
}
}
} else {
dir_size = path.as_ref().metadata()?.len();
files.push(item);
}
Ok(DirContent {
dir_size,
files,
directories,
})
}
/// Returns the size of the file or directory in bytes.(!important: folders size not count)
///
/// If used on a directory, this function will recursively iterate over every file and every
/// directory inside the directory. This can be very time consuming if used on large directories.
///
/// Does not follow symlinks.
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `path` directory does not exist.
/// * Invalid `path`.
/// * The current process does not have the permission to access `path`.
///
/// # Examples
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::get_size;
///
/// let folder_size = get_size("dir")?;
/// println!("{}", folder_size); // print directory size in bytes
/// ```
pub fn get_size<P>(path: P) -> Result<u64>
where
P: AsRef<Path>,
{
// Using `fs::symlink_metadata` since we don't want to follow symlinks,
// as we're calculating the exact size of the requested path itself.
let path_metadata = path.as_ref().symlink_metadata()?;
let mut size_in_bytes = 0;
if path_metadata.is_dir() {
for entry in read_dir(&path)? {
let entry = entry?;
// `DirEntry::metadata` does not follow symlinks (unlike `fs::metadata`), so in the
// case of symlinks, this is the size of the symlink itself, not its target.
let entry_metadata = entry.metadata()?;
if entry_metadata.is_dir() {
// The size of the directory entry itself will be counted inside the `get_size()` call,
// so we intentionally don't also add `entry_metadata.len()` to the total here.
size_in_bytes += get_size(entry.path())?;
} else {
size_in_bytes += entry_metadata.len();
}
}
} else {
size_in_bytes = path_metadata.len();
}
Ok(size_in_bytes)
}
/// Copies the directory contents from one place to another using recursive method,
/// with information about progress. This function will also copy the
/// permission bits of the original files to destination files (not for directories).
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `from` path is not a directory.
/// * This `from` directory does not exist.
/// * Invalid folder name for `from` or `to`.
/// * The current process does not have the permission to access `from` or write `to`.
///
/// # Example
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::copy;
///
/// let options = CopyOptions::new(); //Initialize default values for CopyOptions
/// let handle = |process_info: TransitProcess| {
/// println!("{}", process_info.total_bytes);
/// fs_extra::dir::TransitProcessResult::ContinueOrAbort
/// }
/// // copy source/dir1 to target/dir1
/// copy_with_progress("source/dir1", "target/dir1", &options, handle)?;
///
/// ```
pub fn copy_with_progress<P, Q, F>(
from: P,
to: Q,
options: &CopyOptions,
mut progress_handler: F,
) -> Result<u64>
where
P: AsRef<Path>,
Q: AsRef<Path>,
F: FnMut(TransitProcess) -> TransitProcessResult,
{
let from = from.as_ref();
if !from.exists() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" does not exist or you don't have access!", msg);
err!(&msg, ErrorKind::NotFound);
}
err!(
"Path does not exist or you don't have access!",
ErrorKind::NotFound
);
}
let mut to: PathBuf = to.as_ref().to_path_buf();
if !from.is_dir() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" is not a directory!", msg);
err!(&msg, ErrorKind::InvalidFolder);
}
err!("Path is not a directory!", ErrorKind::InvalidFolder);
}
let dir_name;
if let Some(val) = from.components().last() {
dir_name = val.as_os_str();
} else {
err!("Invalid folder from", ErrorKind::InvalidFolder);
}
if (to.exists() || !options.copy_inside) && !options.content_only {
to.push(dir_name);
}
let mut read_options = DirOptions::new();
if options.depth > 0 {
read_options.depth = options.depth;
}
let dir_content = get_dir_content2(from, &read_options)?;
for directory in dir_content.directories {
let tmp_to = Path::new(&directory).strip_prefix(from)?;
let dir = to.join(&tmp_to);
if !dir.exists() {
if options.copy_inside {
create_all(dir, false)?;
} else {
create(dir, false)?;
}
}
}
let mut result: u64 = 0;
let mut info_process = TransitProcess {
copied_bytes: 0,
total_bytes: dir_content.dir_size,
file_bytes_copied: 0,
file_total_bytes: 0,
file_name: String::new(),
state: TransitState::Normal,
};
let mut options = options.clone();
for file in dir_content.files {
let mut to = to.to_path_buf();
let tp = Path::new(&file).strip_prefix(from)?;
let path = to.join(&tp);
let file_name = path.file_name();
if file_name.is_none() {
err!("No file name");
}
let file_name = file_name.unwrap();
to.push(file_name);
let mut file_options = super::file::CopyOptions {
overwrite: options.overwrite,
skip_exist: options.skip_exist,
buffer_size: options.buffer_size,
};
if let Some(file_name) = file_name.to_str() {
info_process.file_name = file_name.to_string();
} else {
err!("Invalid file name", ErrorKind::InvalidFileName);
}
info_process.file_bytes_copied = 0;
info_process.file_total_bytes = Path::new(&file).metadata()?.len();
let mut result_copy: Result<u64>;
let mut work = true;
let copied_bytes = result;
while work {
{
let _progress_handler = |info: super::file::TransitProcess| {
info_process.copied_bytes = copied_bytes + info.copied_bytes;
info_process.file_bytes_copied = info.copied_bytes;
progress_handler(info_process.clone());
};
result_copy =
super::file::copy_with_progress(&file, &path, &file_options, _progress_handler);
}
match result_copy {
Ok(val) => {
result += val;
work = false;
}
Err(err) => match err.kind {
ErrorKind::AlreadyExists => {
let mut info_process = info_process.clone();
info_process.state = TransitState::Exists;
let user_decide = progress_handler(info_process);
match user_decide {
TransitProcessResult::Overwrite => {
file_options.overwrite = true;
}
TransitProcessResult::OverwriteAll => {
file_options.overwrite = true;
options.overwrite = true;
}
TransitProcessResult::Skip => {
file_options.skip_exist = true;
}
TransitProcessResult::SkipAll => {
file_options.skip_exist = true;
options.skip_exist = true;
}
TransitProcessResult::Retry => {}
TransitProcessResult::ContinueOrAbort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
TransitProcessResult::Abort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
}
}
ErrorKind::PermissionDenied => {
let mut info_process = info_process.clone();
info_process.state = TransitState::Exists;
let user_decide = progress_handler(info_process);
match user_decide {
TransitProcessResult::Overwrite => {
err!("Overwrite denied for this situation!", ErrorKind::Other);
}
TransitProcessResult::OverwriteAll => {
err!("Overwrite denied for this situation!", ErrorKind::Other);
}
TransitProcessResult::Skip => {
file_options.skip_exist = true;
}
TransitProcessResult::SkipAll => {
file_options.skip_exist = true;
options.skip_exist = true;
}
TransitProcessResult::Retry => {}
TransitProcessResult::ContinueOrAbort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
TransitProcessResult::Abort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
}
}
_ => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
},
}
}
}
Ok(result)
}
/// Moves the directory contents from one place to another.
/// This function will also copy the permission bits of the original files to
/// destination files (not for directories).
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `from` path is not a directory.
/// * This `from` directory does not exist.
/// * Invalid folder name for `from` or `to`.
/// * The current process does not have the permission to access `from` or write `to`.
///
/// # Example
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::move_dir;
///
/// let options = CopyOptions::new(); //Initialize default values for CopyOptions
///
/// // move source/dir1 to target/dir1
/// move_dir("source/dir1", "target/dir1", &options)?;
///
/// ```
pub fn move_dir<P, Q>(from: P, to: Q, options: &CopyOptions) -> Result<u64>
where
P: AsRef<Path>,
Q: AsRef<Path>,
{
let mut is_remove = true;
if options.skip_exist && to.as_ref().exists() && !options.overwrite {
is_remove = false;
}
let from = from.as_ref();
if !from.exists() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" does not exist", msg);
err!(&msg, ErrorKind::NotFound);
}
err!(
"Path does not exist or you don't have access!",
ErrorKind::NotFound
);
}
let mut to: PathBuf = to.as_ref().to_path_buf();
if !from.is_dir() {
if let Some(msg) = from.to_str() {
let msg = format!(
"Path \"{}\" is not a directory or you don't have access!",
msg
);
err!(&msg, ErrorKind::InvalidFolder);
}
err!(
"Path is not a directory or you don't have access!",
ErrorKind::InvalidFolder
);
}
let dir_name;
if let Some(val) = from.components().last() {
dir_name = val.as_os_str();
} else {
err!("Invalid folder from", ErrorKind::InvalidFolder);
}
if (to.exists() || !options.copy_inside) && !options.content_only {
to.push(dir_name);
}
let dir_content = get_dir_content(from)?;
for directory in dir_content.directories {
let tmp_to = Path::new(&directory).strip_prefix(from)?;
let dir = to.join(&tmp_to);
if !dir.exists() {
if options.copy_inside {
create_all(dir, false)?;
} else {
create(dir, false)?;
}
}
}
let mut result: u64 = 0;
for file in dir_content.files {
let to = to.to_path_buf();
let tp = Path::new(&file).strip_prefix(from)?;
let path = to.join(&tp);
let file_options = super::file::CopyOptions {
overwrite: options.overwrite,
skip_exist: options.skip_exist,
buffer_size: options.buffer_size,
};
let mut result_copy: Result<u64>;
let mut work = true;
while work {
{
result_copy = super::file::move_file(&file, &path, &file_options);
match result_copy {
Ok(val) => {
result += val;
work = false;
}
Err(err) => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
}
}
}
}
if is_remove {
remove(from)?;
}
Ok(result)
}
/// Moves the directory contents from one place to another with information about progress.
/// This function will also copy the permission bits of the original files to
/// destination files (not for directories).
///
/// # Errors
///
/// This function will return an error in the following situations, but is not limited to just
/// these cases:
///
/// * This `from` path is not a directory.
/// * This `from` directory does not exist.
/// * Invalid folder name for `from` or `to`.
/// * The current process does not have the permission to access `from` or write `to`.
///
/// # Example
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::move_dir_with_progress;
///
/// let options = CopyOptions::new(); //Initialize default values for CopyOptions
/// let handle = |process_info: TransitProcess| {
/// println!("{}", process_info.total_bytes);
/// fs_extra::dir::TransitProcessResult::ContinueOrAbort
/// }
///
/// // move source/dir1 to target/dir1
/// move_dir_with_progress("source/dir1", "target/dir1", &options, handle)?;
///
/// ```
pub fn move_dir_with_progress<P, Q, F>(
from: P,
to: Q,
options: &CopyOptions,
mut progress_handler: F,
) -> Result<u64>
where
P: AsRef<Path>,
Q: AsRef<Path>,
F: FnMut(TransitProcess) -> TransitProcessResult,
{
let mut is_remove = true;
if options.skip_exist && to.as_ref().exists() && !options.overwrite {
is_remove = false;
}
let from = from.as_ref();
if !from.exists() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" does not exist or you don't have access!", msg);
err!(&msg, ErrorKind::NotFound);
}
err!(
"Path does not exist or you don't have access!",
ErrorKind::NotFound
);
}
let mut to: PathBuf = to.as_ref().to_path_buf();
if !from.is_dir() {
if let Some(msg) = from.to_str() {
let msg = format!("Path \"{}\" is not a directory!", msg);
err!(&msg, ErrorKind::InvalidFolder);
}
err!("Path is not a directory!", ErrorKind::InvalidFolder);
}
let dir_name;
if let Some(val) = from.components().last() {
dir_name = val.as_os_str();
} else {
err!("Invalid folder from", ErrorKind::InvalidFolder);
}
if !(options.content_only || options.copy_inside && !to.exists()) {
to.push(dir_name);
}
let dir_content = get_dir_content(from)?;
for directory in dir_content.directories {
let tmp_to = Path::new(&directory).strip_prefix(from)?;
let dir = to.join(&tmp_to);
if !dir.exists() {
if options.copy_inside {
create_all(dir, false)?;
} else {
create(dir, false)?;
}
}
}
let mut result: u64 = 0;
let mut info_process = TransitProcess {
copied_bytes: 0,
total_bytes: dir_content.dir_size,
file_bytes_copied: 0,
file_total_bytes: 0,
file_name: String::new(),
state: TransitState::Normal,
};
let mut options = options.clone();
for file in dir_content.files {
let mut to = to.to_path_buf();
let tp = Path::new(&file).strip_prefix(from)?;
let path = to.join(&tp);
let file_name = path.file_name();
if file_name.is_none() {
err!("No file name");
}
let file_name = file_name.unwrap();
to.push(file_name);
let mut file_options = super::file::CopyOptions {
overwrite: options.overwrite,
skip_exist: options.skip_exist,
buffer_size: options.buffer_size,
};
if let Some(file_name) = file_name.to_str() {
info_process.file_name = file_name.to_string();
} else {
err!("Invalid file name", ErrorKind::InvalidFileName);
}
info_process.file_bytes_copied = 0;
info_process.file_total_bytes = Path::new(&file).metadata()?.len();
let mut result_copy: Result<u64>;
let mut work = true;
let copied_bytes = result;
while work {
{
let _progress_handler = |info: super::file::TransitProcess| {
info_process.copied_bytes = copied_bytes + info.copied_bytes;
info_process.file_bytes_copied = info.copied_bytes;
progress_handler(info_process.clone());
};
result_copy = super::file::move_file_with_progress(
&file,
&path,
&file_options,
_progress_handler,
);
}
match result_copy {
Ok(val) => {
result += val;
work = false;
}
Err(err) => match err.kind {
ErrorKind::AlreadyExists => {
let mut info_process = info_process.clone();
info_process.state = TransitState::Exists;
let user_decide = progress_handler(info_process);
match user_decide {
TransitProcessResult::Overwrite => {
file_options.overwrite = true;
}
TransitProcessResult::OverwriteAll => {
file_options.overwrite = true;
options.overwrite = true;
}
TransitProcessResult::Skip => {
is_remove = false;
file_options.skip_exist = true;
}
TransitProcessResult::SkipAll => {
is_remove = false;
file_options.skip_exist = true;
options.skip_exist = true;
}
TransitProcessResult::Retry => {}
TransitProcessResult::ContinueOrAbort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
TransitProcessResult::Abort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
}
}
ErrorKind::PermissionDenied => {
let mut info_process = info_process.clone();
info_process.state = TransitState::Exists;
let user_decide = progress_handler(info_process);
match user_decide {
TransitProcessResult::Overwrite => {
err!("Overwrite denied for this situation!", ErrorKind::Other);
}
TransitProcessResult::OverwriteAll => {
err!("Overwrite denied for this situation!", ErrorKind::Other);
}
TransitProcessResult::Skip => {
is_remove = false;
file_options.skip_exist = true;
}
TransitProcessResult::SkipAll => {
file_options.skip_exist = true;
options.skip_exist = true;
}
TransitProcessResult::Retry => {}
TransitProcessResult::ContinueOrAbort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
TransitProcessResult::Abort => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
}
}
_ => {
let err_msg = err.to_string();
err!(err_msg.as_str(), err.kind)
}
},
}
}
}
if is_remove {
remove(from)?;
}
Ok(result)
}
/// Removes directory.
///
/// # Example
/// ```rust,ignore
/// extern crate fs_extra;
/// use fs_extra::dir::remove;
///
/// remove("source/dir1"); // remove dir1
/// ```
pub fn remove<P: AsRef<Path>>(path: P) -> Result<()> {
if path.as_ref().exists() {
Ok(remove_dir_all(path)?)
} else {
Ok(())
}
}