Compare commits
3 commits
3be53a969d
...
f2315636da
Author | SHA1 | Date | |
---|---|---|---|
f2315636da | |||
2f236b752c | |||
b593a8f67e |
5 changed files with 83 additions and 6 deletions
|
@ -5,12 +5,12 @@ 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.
|
- [ ] `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.
|
- [x] `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.
|
||||||
- [ ] `std::fs::hard_link` - `link(path)create()` - Creates a new hard link on the filesystem.
|
- [ ] `std::fs::hard_link` - `link(path)create()` - Creates a new hard link on the filesystem.
|
||||||
- [ ] `std::fs::metadata` - `path(path).metadata()` - Given a path, query the file system to get information about a file, directory, etc.
|
- [ ] `std::fs::metadata` - `path(path).metadata()` - Given a path, query the file system to get information about a file, directory, etc.
|
||||||
- [ ] `std::fs::read` - `file(path).reader().bytes()` - Read the entire contents of a file into a bytes vector.
|
- [x] `std::fs::read` - `file(path).reader().bytes()` - Read the entire contents of a file into a bytes vector.
|
||||||
- [x] `std::fs::read_dir` - `dir(path).read()` - Returns an iterator over the entries within a directory.
|
- [x] `std::fs::read_dir` - `dir(path).read()` - Returns an iterator over the entries within a directory.
|
||||||
- [ ] `std::fs::read_link` - `link(path).read()` - Reads a symbolic link, returning the file that the link points to.
|
- [ ] `std::fs::read_link` - `link(path).read()` - Reads a symbolic link, returning the file that the link points to.
|
||||||
- [x] `std::fs::read_to_string` - `file(path).reader().to_string()` - Read the entire contents of a file into a string.
|
- [x] `std::fs::read_to_string` - `file(path).reader().to_string()` - Read the entire contents of a file into a string.
|
||||||
|
|
|
@ -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]
|
||||||
|
|
|
@ -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)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -65,6 +65,23 @@ impl Reader {
|
||||||
pub fn lines(&self) -> Lines<'_> {
|
pub fn lines(&self) -> Lines<'_> {
|
||||||
self.contents.lines()
|
self.contents.lines()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Returns the contents of the file as bytes.
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use kxio::fs::Result;
|
||||||
|
/// # fn main() -> Result<()> {
|
||||||
|
/// let fs = kxio::fs::temp()?;
|
||||||
|
/// let path = fs.base().join("foo");
|
||||||
|
/// let file = fs.file(&path);
|
||||||
|
/// # file.write("new file contents")?;
|
||||||
|
/// let bytes = file.reader()?.bytes();
|
||||||
|
/// # Ok(())
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
pub fn bytes(&self) -> &[u8] {
|
||||||
|
self.contents.as_bytes()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
impl Display for Reader {
|
impl Display for Reader {
|
||||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
|
39
tests/fs.rs
39
tests/fs.rs
|
@ -385,3 +385,42 @@ mod path_is_file {
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
mod copy {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn should_copy_a_file() -> TestResult {
|
||||||
|
let fs = fs::temp().expect("temp fs");
|
||||||
|
let src_path = fs.base().join("foo");
|
||||||
|
let src = fs.file(&src_path);
|
||||||
|
src.write("bar").expect("write");
|
||||||
|
let dst_path = fs.base().join("bar");
|
||||||
|
let dst = fs.file(&dst_path);
|
||||||
|
src.copy(&dst).expect("copy");
|
||||||
|
let src_contents = src.reader().expect("reader").to_string();
|
||||||
|
let dst_contents = dst.reader().expect("reader").to_string();
|
||||||
|
assert_eq!(src_contents, dst_contents);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mod reader {
|
||||||
|
use super::*;
|
||||||
|
mod bytes {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn should_return_bytes() -> TestResult {
|
||||||
|
let fs = fs::temp().expect("temp fs");
|
||||||
|
let path = fs.base().join("foo");
|
||||||
|
let file = fs.file(&path);
|
||||||
|
file.write("bar").expect("write");
|
||||||
|
let reader = file.reader().expect("reader");
|
||||||
|
let bytes = reader.bytes();
|
||||||
|
assert_eq!(bytes.len(), 3);
|
||||||
|
assert_eq!(bytes[0], b'b');
|
||||||
|
assert_eq!(bytes[1], b'a');
|
||||||
|
assert_eq!(bytes[2], b'r');
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in a new issue