devela/sys/fs/
namespace.rs

Help
1// devela::sys::fs::namespace
2//
3//! `Fs` namespace.
4//
5
6use crate::{
7    FileMetadata, FilePermissions, IoResult, IterDirRead, Path, PathBuf,
8    _dep::_std::fs::{
9        canonicalize, copy, create_dir, create_dir_all, exists, hard_link, metadata, read,
10        read_dir, read_link, read_to_string, remove_dir, remove_dir_all, remove_file, rename,
11        set_permissions, symlink_metadata, write,
12    },
13};
14
15#[doc = crate::TAG_NAMESPACE!()]
16/// Filesystem-related operations.
17///
18/// See also: [`ExtPath`][crate::ExtPath], [`fsPath`][crate::FsPath].
19pub struct Fs;
20
21/// # Safe methods.
22#[rustfmt::skip]
23impl Fs {
24    /// Returns the canonical, absolute form of a path with all intermediate components normalized
25    /// and symbolic links resolved.
26    ///
27    /// See `std::sys::`[`canonicalize`].
28    pub fn canonicalize<P: AsRef<Path>>(path: P) -> IoResult<PathBuf> { canonicalize(path) }
29
30    /// Copies the contents of one file to another. This function will also copy the permission
31    /// bits of the original file to the destination file.
32    ///
33    /// See `std::sys::`[`copy`].
34    pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> IoResult<u64> { copy(from, to) }
35
36    /// Creates a new, empty directory at the provided path
37    ///
38    /// See `std::sys::`[`create_dir`].
39    pub fn create_dir<P: AsRef<Path>>(path: P) -> IoResult<()> { create_dir(path) }
40
41    /// Recursively create a directory and all of its parent components if they are missing.
42    ///
43    /// See `std::sys::`[`create_dir_all`].
44    pub fn create_dir_all<P: AsRef<Path>>(path: P) -> IoResult<()> { create_dir_all(path) }
45
46    /// Returns Ok(true) if the path points at an existing entity.
47    ///
48    /// See `std::sys::`[`exists`].
49    pub fn exists<P: AsRef<Path>>(path: P) -> IoResult<bool> { exists(path) }
50
51    /// Creates a new hard link on the filesystem.
52    ///
53    /// See `std::sys::`[`hard_link`].
54    pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(original: P, link: Q) -> IoResult<()> {
55        hard_link(original, link)
56    }
57
58    /// Given a path, queries the file system to get information about a file, directory, etc.
59    ///
60    /// See `std::sys::`[`metadata`].
61    pub fn metadata<P: AsRef<Path>>(path: P) -> IoResult<FileMetadata> { metadata(path) }
62
63    /// Reads the entire contents of a file into a bytes vector.
64    ///
65    /// See `std::sys::`[`read`].
66    pub fn read<P: AsRef<Path>>(path: P) -> IoResult<Vec<u8>> { read(path) }
67
68    /// Returns an iterator over the entries within a directory.
69    ///
70    /// See `std::sys::`[`read_dir`].
71    pub fn read_dir<P: AsRef<Path>>(path: P) -> IoResult<IterDirRead> { read_dir(path) }
72
73    /// Reads a symbolic link, returning the file that the link points to.
74    ///
75    /// See `std::sys::`[`read_link`].
76    pub fn read_link<P: AsRef<Path>>(path: P) -> IoResult<PathBuf> { read_link(path) }
77
78    /// Reads the entire contents of a file into a string.
79    ///
80    /// See `std::sys::`[`read_to_string`].
81    pub fn read_to_string<P: AsRef<Path>>(path: P) -> IoResult<String> { read_to_string(path) }
82
83    /// Removes an empty directory.
84    ///
85    /// See `std::sys::`[`remove_dir`].
86    pub fn remove_dir<P: AsRef<Path>>(path: P) -> IoResult<()> { remove_dir(path) }
87
88    /// Removes a directory at this path, after removing all its contents. Use carefully!
89    ///
90    /// See `std::sys::`[`remove_dir_all`].
91    pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> IoResult<()> { remove_dir_all(path) }
92
93    /// Removes a file from the filesystem.
94    ///
95    /// See `std::sys::`[`remove_file`].
96    pub fn remove_file<P: AsRef<Path>>(path: P) -> IoResult<()> { remove_file(path) }
97
98    /// Renames a file or directory to a new name, replacing the original file if to already
99    /// exists.
100    ///
101    /// See `std::sys::`[`rename`].
102    pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> IoResult<()> {
103        rename(from, to)
104    }
105
106    /// Changes the permissions found on a file or a directory.
107    ///
108    /// See `std::sys::`[`set_permissions`].
109    pub fn set_permissions<P: AsRef<Path>>(path: P, perm: FilePermissions) -> IoResult<()> {
110        set_permissions(path, perm)
111    }
112
113    /// Queries the metadata about a file without following symlinks.
114    ///
115    /// See `std::sys::`[`symlink_metadata`].
116    pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> IoResult<FileMetadata> {
117        symlink_metadata(path)
118    }
119
120    /// Writes a slice as the entire contents of a file.
121    ///
122    /// See `std::sys::`[`fn@write`].
123    pub fn write<P: AsRef<Path>, C: AsRef<[u8]>>(path: P, contents: C) -> IoResult<()> {
124        write(path, contents)
125    }
126}
devela/sys/fs/namespace.rs

devela/sys/fs/
namespace.rs
