Compare commits

..

3 commits

Author SHA1 Message Date
c1c0ea22de refactor(fs): use type aliases 2024-11-03 11:33:24 +00:00
55a73cbbf1 feat(fs): add copy 2024-11-03 11:32:45 +00:00
a879c6fa15 feat(fs): add canonicalize
Some checks failed
Rust / build (map[name:nightly]) (push) Successful in 1m52s
Rust / build (map[name:stable]) (push) Has been cancelled
2024-11-03 11:19:53 +00:00
4 changed files with 45 additions and 5 deletions

View file

@ -4,7 +4,7 @@ Provides injectable Filesystem and Network resources to make code more testable.
#### std::fs alternatives #### std::fs alternatives
- [ ] `std::fs::canonicalize` - `path(path).canonicalize()` - Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved. - [x] `std::fs::canonicalize` - `path(path).canonicalize()` - Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved.
- [ ] `std::fs::copy` - `file(path).copy(target)` - Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file. - [ ] `std::fs::copy` - `file(path).copy(target)` - Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file.
- [x] `std::fs::create_dir` - `dir(path).create()` - Creates a new, empty directory at the provided path - [x] `std::fs::create_dir` - `dir(path).create()` - Creates a new, empty directory at the provided path
- [x] `std::fs::create_dir_all` - `dir(path).create_all()` - Recursively create a directory and all of its parent components if they are missing. - [x] `std::fs::create_dir_all` - `dir(path).create_all()` - Recursively create a directory and all of its parent components if they are missing.

View file

@ -3,10 +3,10 @@ use crate::fs::{DirItem, DirItemIterator, Result};
use super::{ use super::{
path::{DirMarker, PathReal}, path::{DirMarker, PathReal},
Error, FileMarker, PathMarker, DirHandle, Error, FileMarker, PathMarker,
}; };
impl<'base, 'path> PathReal<'base, 'path, DirMarker> { impl<'base, 'path> DirHandle<'base, 'path> {
/// Creates a new, empty directory at the path /// Creates a new, empty directory at the path
/// ///
/// Wrapper for [std::fs::create_dir] /// Wrapper for [std::fs::create_dir]

View file

@ -4,10 +4,10 @@ use crate::fs::Result;
use super::{ use super::{
path::{FileMarker, PathReal}, path::{FileMarker, PathReal},
reader::Reader, reader::Reader,
Error, Error, FileHandle,
}; };
impl<'base, 'path> PathReal<'base, 'path, FileMarker> { impl<'base, 'path> FileHandle<'base, 'path> {
/// Returns a [Reader] for the file. /// Returns a [Reader] for the file.
/// ///
/// ``` /// ```
@ -41,4 +41,25 @@ impl<'base, 'path> PathReal<'base, 'path, FileMarker> {
self.check_error()?; self.check_error()?;
std::fs::write(self.as_pathbuf(), contents).map_err(Error::Io) std::fs::write(self.as_pathbuf(), contents).map_err(Error::Io)
} }
/// Copies the contents of a file to another file.
///
/// Wrapper for [std::fs::copy]
///
/// ```
/// # fn try_main() -> kxio::fs::Result<()> {
/// let fs = kxio::fs::temp()?;
/// let src_path = fs.base().join("foo");
/// let dest_path = fs.base().join("bar");
/// let src = fs.file(&src_path);
/// # fs.file(&dest_path).write("new file contents")?;
/// let dest = fs.file(&dest_path);
/// src.copy(&dest)?;
/// # Ok(())
/// # }
/// ```
pub fn copy(&self, dest: &PathReal<'base, 'path, FileMarker>) -> Result<u64> {
self.check_error()?;
std::fs::copy(self.as_pathbuf(), dest.as_pathbuf()).map_err(Error::Io)
}
} }

View file

@ -201,6 +201,25 @@ impl<'base, 'path, T: PathType> PathReal<'base, 'path, T> {
Ok(None) Ok(None)
} }
} }
/// Returns the canonical, absolute form of the path with all intermediate
/// components normalized and symbolic links resolved.
///
/// ```
/// # use kxio::fs::Result;
/// # fn main() -> Result<()> {
/// let fs = kxio::fs::temp()?;
/// let path = fs.base().join("foo");
/// # fs.dir(&path).create()?;
/// let dir = fs.path(&path);
/// let canonical = dir.canonicalize()?;
/// # Ok(())
/// # }
/// ```
pub fn canonicalize(&self) -> Result<PathBuf> {
self.check_error()?;
self.as_pathbuf().canonicalize().map_err(Error::Io)
}
} }
impl From<PathReal<'_, '_, PathMarker>> for PathBuf { impl From<PathReal<'_, '_, PathMarker>> for PathBuf {
fn from(path: PathReal<PathMarker>) -> Self { fn from(path: PathReal<PathMarker>) -> Self {