Crates.io | simple-fs |
lib.rs | simple-fs |
version | 0.3.1 |
source | src |
created_at | 2023-12-27 19:25:29.818297 |
updated_at | 2024-11-24 19:42:20.798133 |
description | Simple and convenient API for File System access |
homepage | https://github.com/jeremychone/rust-simple-fs |
repository | https://github.com/jeremychone/rust-simple-fs |
max_upload_size | |
id | 1081826 |
size | 66,467 |
simple-fs is a crate that provides a set of convenient and common file APIs built on std::fs
, walkdir, and globset.
Feature | Functions Included |
---|---|
with-json |
load_json , save_json , save_json_pretty |
with-toml |
load_toml , save_toml |
bin-nums |
save_be_f64 , load_be_f64 , save_le_f64 , ... |
full |
All the above. |
default | None of the above. See below. |
0.3.1
from 0.3.0
list/iter
files.
*
was going through the subfolder /
, which was not the intended way.0.3.1
, it uses the glob literal_separator = true
, so it won't descend further.*.rs
to list direct descendants and **/*.rs
for nested files.dir
given in the list, otherwise, set ListOptions.relative_glob = true
to make it relative.0.3.x
from 0.2.x
0.2.0
from 0.1.x
simple-fs
operates under the assumption that paths which are not utf8
are not visible to the API, simplifying many of the path-related APIs.
The two constructs that follow this assumption are (both are just wrappers of PathBuf with some guarantees):
SPath
, which ensures that the contained path is a valid UTF-8 path and includes a file name.
SFile
, which carries the same guarantees as SPath
but also checks if the file is_file()
, confirming the file's existence at the time of SFile
construction.
By establishing these rules, APIs such as .file_name()
, .file_stem()
, and .to_str()
are much simpler, as they all return &str
.
The crate also includes other convenient, common APIs:
read_to_string
, which reports the file path if not found.get_buf_reader
, which also reports the file path if not found or in case of an error.iter_files(dir, include_globs: &[&str], exclude_globs: &[&str]) -> Result<impl Iter SFile>
list_files(..same as iter_files..) -> Result<Vec<SFile>>
ensure_dir(dir_path)
, ensure_file_dir(file_path)
For more control, it is recommended to use std::fs
, walkdir
, globset
, and other crates directly.
This is a very early implementation, with more to come.
Happy coding!