Expand description
Contains various std::fs wrapper functions that also contain the target path in their errors.
Re-exports§
use crate::errors::FsPathError;🔒use flate2::Compression;🔒use flate2::read::GzDecoder;🔒use flate2::write::GzEncoder;🔒use serde::Serialize;🔒use serde::Serialize;🔒use serde::de::DeserializeOwned;🔒use std::fs;🔒use std::fs::File;🔒use std::io::BufReader;🔒use std::io::BufWriter;🔒use std::io::Read;🔒use std::io::Seek;🔒use std::io::SeekFrom;🔒use std::io::Write;🔒use std::path::Component;🔒use std::path::Path;🔒use std::path::PathBuf;🔒use std::os::unix::fs::OpenOptionsExt;🔒Unix use std::os::unix::fs::PermissionsExt;🔒Unix
Functions§
- canonicalize_
path - Canonicalize a path, returning an error if the path does not exist.
- copy
- Wrapper for
std::fs::copy - create_
dir - Wrapper for
std::fs::create_dir - create_
dir_ all - Wrapper for
std::fs::create_dir_all - create_
file - Wrapper for
File::create. - files_
with_ ext - Returns an iterator over all files with the given extension under the
rootdir. - json_
files - Returns an iterator over all JSON files under the
rootdir. - locked_
read - Reads the entire contents of a locked shared file into a bytes vector.
- locked_
read_ to_ string - Reads the entire contents of a locked shared file into a string.
- locked_
write - Writes all content in an exclusive locked file.
- locked_
write_ line - Writes a line in an exclusive locked file.
- locked_
write_ 🔒line_ windows - normalize_
path - Normalize a path, removing things like
.and... - open
- Wrapper for
std::fs::File::open - read
- Wrapper for
std::fs::read. - read_
inner 🔒 - read_
json_ file - Reads the JSON file and deserialize it into the provided type.
- read_
json_ gzip_ file - Reads and decodes the json gzip file, then deserialize it into the provided type.
- read_
link - Wrapper for
std::fs::read_link. - read_
to_ string - Wrapper for
std::fs::read_to_string. - remove_
dir - Wrapper for
std::fs::remove_dir - remove_
dir_ all - Wrapper for
std::fs::remove_dir_all - remove_
file - Wrapper for
std::fs::remove_file. - write
- Wrapper for
std::fs::write - write_
json_ file - Writes the object as a JSON object.
- write_
json_ gzip_ file - Writes the object as a gzip compressed file.
- write_
pretty_ 🔒json - write_
pretty_ json_ file - Writes the object as a pretty JSON object.
- write_
sensitive_ json_ file - Writes an object as pretty JSON with owner-only permissions on Unix.