1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
//! A library for reading and writing directory structures.
//!
//! This library provides a macro for defining directory structures, and a
//! trait for reading and writing those structures to / from disk.
//!
//! # Example
//!
//! ## Writing a structure to disk
//! ```
//! use std::path::Path;
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//! use dir_structure::DirStructureItem;
//! #[derive(dir_structure::DirStructure)]
//! struct Dir {
//! #[dir_structure(path = "f1.txt")]
//! f1: String,
//! #[dir_structure(path = "subdir/f2.txt")]
//! f2: String,
//! // default path is just a file name from the field's name.
//! f3: String,
//! // also works with nested structures
//! #[dir_structure(path = "subdir2")]
//! subdir: Subdir,
//! }
//! #[derive(dir_structure::DirStructure)]
//! struct Subdir {
//! #[dir_structure(path = "f4.txt")]
//! f4: String,
//! }
//!
//! let d = Path::new("dir");
//! Dir {
//! f1: "f1".to_owned(),
//! f2: "f2".to_owned(),
//! f3: "f3".to_owned(),
//! subdir: Subdir {
//! f4: "f4".to_owned(),
//! },
//! }.write(&d)?;
//! assert_eq!(std::fs::read_to_string(d.join("f1.txt"))?, "f1");
//! assert_eq!(std::fs::read_to_string(d.join("subdir/f2.txt"))?, "f2");
//! assert_eq!(std::fs::read_to_string(d.join("f3"))?, "f3");
//! assert_eq!(std::fs::read_to_string(d.join("subdir2/f4.txt"))?, "f4");
//!
//! # std::fs::remove_dir_all(&d)?;
//!
//! Ok(())
//! }
//! ```
//!
//! ## Reading a structure from disk
//!
//! ```
//! use std::path::Path;
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//! use dir_structure::DirStructureItem;
//! #[derive(dir_structure::DirStructure)]
//! struct Dir {
//! #[dir_structure(path = "f1.txt")]
//! f1: String,
//! #[dir_structure(path = "subdir/f2.txt")]
//! f2: String,
//! // default path is just a file name from the field's name.
//! f3: String,
//! // also works with nested structures
//! #[dir_structure(path = "subdir2")]
//! subdir: Subdir,
//! }
//! #[derive(dir_structure::DirStructure)]
//! struct Subdir {
//! #[dir_structure(path = "f4.txt")]
//! f4: String,
//! }
//! let d = Path::new("dir");
//! std::fs::create_dir_all(&d)?;
//! std::fs::create_dir_all(d.join("subdir"))?;
//! std::fs::create_dir_all(d.join("subdir2"))?;
//! std::fs::write(d.join("f1.txt"), "f1")?;
//! std::fs::write(d.join("subdir/f2.txt"), "f2")?;
//! std::fs::write(d.join("f3"), "f3")?;
//! std::fs::write(d.join("subdir2/f4.txt"), "f4")?;
//! let dir = Dir::read(&d)?;
//! assert_eq!(dir.f1, "f1");
//! assert_eq!(dir.f2, "f2");
//! assert_eq!(dir.f3, "f3");
//! assert_eq!(dir.subdir.f4, "f4");
//!
//! # std::fs::remove_dir_all(&d)?;
//!
//! Ok(())
//! }
//! ```
use std::ffi::{OsStr, OsString};
use std::fmt::Display;
use std::fs::File;
use std::path::{Path, PathBuf};
use std::str::FromStr;
#[derive(Debug, thiserror::Error)]
pub enum Error {
#[error("IO error at {0:?}: {1}")]
Io(PathBuf, #[source] std::io::Error),
#[error("Parse error at {0:?}: {1}")]
Parse(PathBuf, #[source] Box<dyn std::error::Error + Send + Sync>),
}
trait WrapIoError: Sized {
type Output;
fn wrap_io_error(self, get_path: impl FnOnce() -> PathBuf) -> Result<Self::Output>;
fn wrap_io_error_with(self, path: &Path) -> Result<Self::Output> {
self.wrap_io_error(|| path.to_path_buf())
}
}
impl<T> WrapIoError for std::io::Result<T> {
type Output = T;
fn wrap_io_error(self, get_path: impl FnOnce() -> PathBuf) -> Result<Self::Output> {
self.map_err(|e| Error::Io(get_path(), e))
}
}
pub type Result<T> = std::result::Result<T, Error>;
/// The main trait. This is implemented for
/// all directory structures by the derive macro.
///
/// This trait doesn't have any methods, just a supertype:
/// [`DirStructureItem`].
pub trait DirStructure: DirStructureItem {}
/// Helper trait, implemented for all types that have a [`ReadFrom`]
/// and [`WriteTo`] implementation.
pub trait DirStructureItem: ReadFrom + WriteTo {
/// Uses the [`ReadFrom`] implementation to read the structure from
/// disk, from the specified path.
fn read(path: impl AsRef<Path>) -> Result<Self>
where
Self: Sized,
{
Self::read_from(path.as_ref())
}
/// Uses the [`WriteTo`] implementation to write the structure
/// to disk at the specified path.
fn write(&self, path: impl AsRef<Path>) -> Result<()> {
self.write_to(path.as_ref())
}
}
// Blanket impl.
impl<T> DirStructureItem for T where T: ReadFrom + WriteTo {}
/// Trait for types / structures that can be
/// read from disk, either from a file or a directory.
pub trait ReadFrom {
/// Reads the structure from the specified path, which
/// can be either a file or a directory.
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized;
}
/// Trait for types / structures that can be
/// written to disk. All types in the library that
/// write to files first check that the parent
/// directories exist, so implementations of
/// this that create the whole directory are
/// not necessary (unless used empty children
/// directories, in which case no directories will
/// really be created).
pub trait WriteTo {
/// Writes the structure to the specified path.
fn write_to(&self, path: &Path) -> Result<()>;
}
/// Trait to use when using the `with_newtype` attribute.
///
/// This is used to convert a reference to a normal type
/// (like `String`, `Vec<u8>` etc. into a type that is a
/// reference to them, like `&str`, `&[u8]` etc.), so that
/// the `WriteTo` implementation can be written only for the
/// reference types, and all the other [`WriteTo`] impls will
/// only cast what they have to write to those reference types
/// (via the function below), and then call the [`WriteTo::write_to`]
/// method on that reference.
pub trait FromRefForWriter<'a> {
/// The inner type to cast.
type Inner: ?Sized;
/// The reference type to cast to.
type Wr: WriteTo + 'a;
/// Casts the reference to the inner type to a [`WriteTo`]
/// reference type.
fn from_ref_for_writer(value: &'a Self::Inner) -> Self::Wr;
}
/// Trait to use when using the `with_newtype` attribute.
///
/// This is used to convert a newtype to its inner type.
/// We are using this because we cannot make blanket impls with
/// [`From`] due to the orphan rules.
pub trait NewtypeToInner {
/// The inner type.
type Inner;
/// Converts the newtype to its inner type.
fn into_inner(self) -> Self::Inner;
}
/// A directory structure where we don't know the names of the folders at compile-time,
/// and as such we cannot use the derive macro.
///
/// Instead we know that all the entries in the directory are folders,
/// and that they all have the same structure inside (defined by the [`T`] type parameter),
/// or they are all files (which can be read with [`DirChildren`]<[`String`]> for example).
///
/// In either case, [`<T as ReadFrom>::read_from`] must be able to read all the entries in
/// the directory.
///
/// The [`WriteTo`] implementation will directly write the children to the directory it
/// is passed, with no regards to the path stored in `self_path`.
pub struct DirChildren<T>
where
T: DirStructureItem,
{
/// The path to the root directory.
///
/// This path doesn't influence writing in any way, it is only to
/// point out the directory after it has been read and parsed.
pub self_path: PathBuf,
/// The children of the root directory.
pub children: Vec<DirChild<T>>,
}
impl<T> DirChildren<T>
where
T: DirStructureItem,
{
/// Creates an empty [`DirChildren`], with no children.
pub fn new() -> Self {
Self {
self_path: PathBuf::new(),
children: Vec::new(),
}
}
/// Creates a [`DirChildren`] with the given path and children.
pub fn with_children_from_iter(
self_path: impl Into<PathBuf>,
children: impl IntoIterator<Item = DirChild<T>>,
) -> Self {
Self {
self_path: self_path.into(),
children: children.into_iter().collect(),
}
}
/// Returns the number of children.
pub fn len(&self) -> usize {
self.children.len()
}
/// Gets the child at the specified index.
pub fn get(&self, index: usize) -> Option<&DirChild<T>> {
self.children.get(index)
}
/// Gets the child with the specified "file" name (last segment of path).
pub fn get_name(&self, name: impl AsRef<OsStr>) -> Option<&DirChild<T>> {
self.children
.iter()
.find(|child| child.file_name == name.as_ref())
}
/// Returns an iterator over the children.
pub fn iter(&self) -> DirChildrenIter<'_, T> {
DirChildrenIter(self.children.iter())
}
}
impl<T> ReadFrom for DirChildren<T>
where
T: DirStructureItem,
{
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
let mut children = Vec::new();
for child in path.read_dir().wrap_io_error_with(path)? {
let child = child.wrap_io_error_with(path)?;
let file_name = child.file_name();
let value = T::read_from(&child.path())?;
children.push(DirChild { file_name, value });
}
Ok(DirChildren {
self_path: path.to_path_buf(),
children,
})
}
}
impl<T> WriteTo for DirChildren<T>
where
T: DirStructureItem,
{
fn write_to(&self, path: &Path) -> Result<()> {
for child in &self.children {
let child_path = path.join(&child.file_name);
child.value.write_to(&child_path)?;
}
Ok(())
}
}
/// A single child of a [`DirChildren`] structure.
pub struct DirChild<T>
where
T: DirStructureItem,
{
/// The file name of the child.
file_name: OsString,
/// The parsed value of the child.
value: T,
}
impl<T> DirChild<T>
where
T: DirStructureItem,
{
/// Creates a new [`DirChild`] with the specified file name and value.
pub fn new(file_name: impl Into<OsString>, value: T) -> Self {
Self {
file_name: file_name.into(),
value,
}
}
/// Gets the file name of the child (or the name of the directory; the last segment in the path).
pub fn file_name(&self) -> &OsString {
&self.file_name
}
/// Gets the file name of the child (or the name of the directory; the last segment in the path).
///
/// Mutable reference version of [`Self::file_name`].
pub fn file_name_mut(&mut self) -> &mut OsString {
&mut self.file_name
}
/// Gets the value of the child.
///
/// This is the parsed value of the file / directory.
pub fn value(&self) -> &T {
&self.value
}
/// Gets the value of the child.
///
/// This is the parsed value of the file / directory.
///
/// Mutable reference version of [`Self::value`].
pub fn value_mut(&mut self) -> &mut T {
&mut self.value
}
}
impl<T> IntoIterator for DirChildren<T>
where
T: DirStructureItem,
{
type Item = DirChild<T>;
type IntoIter = std::vec::IntoIter<Self::Item>;
fn into_iter(self) -> Self::IntoIter {
self.children.into_iter()
}
}
/// A [`DirChildren`] iterator. It iterates over the children of a
/// [`DirChildren`] structure.
pub struct DirChildrenIter<'a, T: DirStructureItem>(std::slice::Iter<'a, DirChild<T>>);
impl<'a, T> Iterator for DirChildrenIter<'a, T>
where
T: DirStructureItem,
{
type Item = &'a DirChild<T>;
fn next(&mut self) -> Option<Self::Item> {
self.0.next()
}
fn size_hint(&self) -> (usize, Option<usize>) {
self.0.size_hint()
}
}
impl<'a, T> ExactSizeIterator for DirChildrenIter<'a, T>
where
T: DirStructureItem,
{
fn len(&self) -> usize {
self.0.len()
}
}
/// A simple macro that generates a DirChildren<T> newtype, together with
/// a few impls to make it easy to use.
#[macro_export]
macro_rules! dir_children_wrapper {
($vis:vis $name:ident $ty:ty) => {
$vis struct $name(pub $crate::DirChildren<$ty>);
impl $crate::ReadFrom for $name {
fn read_from(path: &::std::path::Path) -> $crate::Result<Self>
where
Self: Sized,
{
Ok(Self(<$crate::DirChildren<$ty>>::read_from(path)?))
}
}
impl $crate::WriteTo for $name {
fn write_to(&self, path: &::std::path::Path) -> $crate::Result<()> {
self.0.write_to(path)
}
}
impl std::ops::Deref for $name {
type Target = $crate::DirChildren<$ty>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl std::ops::DerefMut for $name {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl std::iter::IntoIterator for $name {
type Item = $crate::DirChild<$ty>;
type IntoIter = std::vec::IntoIter<Self::Item>;
fn into_iter(self) -> Self::IntoIter {
self.0.into_iter()
}
}
};
}
pub use dir_structure_macros::DirStructure;
#[cfg(feature = "json")]
pub mod json {
//! With the `json` feature, this module provides the [`Json`] type,
//!
//! This allows us to read and parse json files to some `serde::Deserialize` type,
//! and write them back to disk.
use std::fmt;
use std::fmt::Formatter;
use std::path::Path;
use std::str::FromStr;
use crate::{FromRefForWriter, ReadFrom, WriteTo};
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
/// thus allowing us to parse and serialize it from / to json when we read / write a
/// directory structure.
#[derive(Debug, Copy, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize, Hash)]
#[serde(transparent)]
pub struct Json<T>(#[serde(bound = "")] pub T)
where
T: 'static + serde::Serialize + for<'d> serde::Deserialize<'d>;
impl<T> FromStr for Json<T>
where
T: serde::Serialize + for<'d> serde::Deserialize<'d> + 'static,
{
type Err = serde_json::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
serde_json::from_str(s).map(Self)
}
}
impl<T> fmt::Display for Json<T>
where
T: serde::Serialize + for<'d> serde::Deserialize<'d> + 'static,
{
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let s = serde_json::to_string(&self.0).map_err(|_| fmt::Error)?;
write!(f, "{}", s)
}
}
impl<T> ReadFrom for Json<T>
where
T: serde::Serialize + for<'d> serde::Deserialize<'d> + 'static,
{
fn read_from(path: &Path) -> crate::Result<Self> {
let contents = crate::FileString::read_from(path)?.0;
let v = serde_json::from_str::<Self>(&contents)
.map_err(|e| crate::Error::Parse(path.to_path_buf(), e.into()))?;
Ok(v)
}
}
impl<T> WriteTo for Json<T> where T: serde::Serialize + for<'d> serde::Deserialize<'d> + 'static {
fn write_to(&self, path: &Path) -> crate::Result<()> {
crate::FileString::from_ref_for_writer(&self.to_string()).write_to(path)
}
}
}
/// A wrapper around a type which will use the [`Display`] and [`FromStr`] implementations
/// for serialization / deserialization.
///
/// For example: u8, i8, i16, u16, all integer types... bool etc.
pub struct FmtWrapper<T>(pub T);
impl<T> NewtypeToInner for FmtWrapper<T> {
type Inner = T;
fn into_inner(self) -> Self::Inner {
self.0
}
}
impl<T> ReadFrom for FmtWrapper<T>
where
T: FromStr,
T::Err: Into<Box<dyn std::error::Error + Send + Sync>>,
{
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
let contents = FileString::read_from(path)?.0;
match contents.parse::<T>() {
Ok(v) => Ok(Self(v)),
Err(e) => Err(Error::Parse(path.to_path_buf(), e.into())),
}
}
}
impl<T> WriteTo for FmtWrapper<T>
where
T: Display,
{
fn write_to(&self, path: &Path) -> Result<()> {
Self::from_ref_for_writer(&self.0).write_to(path)
}
}
impl<'a, T> FromRefForWriter<'a> for FmtWrapper<T>
where
T: Display + 'a,
{
type Inner = T;
type Wr = FmtWrapperRefWr<'a, T>;
fn from_ref_for_writer(value: &'a Self::Inner) -> Self::Wr {
FmtWrapperRefWr(value)
}
}
/// A [`WriteTo`] wrapper around a reference to a type which will use the [`Display`]
/// implementation to write the value.
pub struct FmtWrapperRefWr<'a, T: ?Sized>(pub &'a T);
impl<'a, T> WriteTo for FmtWrapperRefWr<'a, T>
where
T: Display + ?Sized,
{
fn write_to(&self, path: &Path) -> Result<()> {
use std::io::Write;
utils::create_parent_dir(path)?;
let mut f = File::create(path).wrap_io_error_with(path)?;
write!(f, "{}", self.0).wrap_io_error_with(path)?;
Ok(())
}
}
/// A newtype around a [`Vec`]<[`u8`]>.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct FileBytes(pub Vec<u8>);
impl FileBytes {
/// Creates a new [`FileBytes`] from the specified [`Vec`]<[`u8`]>.
pub fn new(v: impl Into<Vec<u8>>) -> Self {
Self(v.into())
}
}
impl ReadFrom for FileBytes {
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
std::fs::read(path).wrap_io_error_with(path).map(Self)
}
}
impl WriteTo for FileBytes {
fn write_to(&self, path: &Path) -> Result<()> {
Self::from_ref_for_writer(&self.0).write_to(path)
}
}
impl From<FileBytes> for Vec<u8> {
fn from(value: FileBytes) -> Self {
value.0
}
}
impl NewtypeToInner for FileBytes {
type Inner = Vec<u8>;
fn into_inner(self) -> Self::Inner {
self.0
}
}
impl<'a> FromRefForWriter<'a> for FileBytes {
type Inner = [u8];
type Wr = FileBytesRefWr<'a>;
fn from_ref_for_writer(value: &'a Self::Inner) -> Self::Wr {
FileBytesRefWr(value)
}
}
/// The [`WriteTo`] wrapper around a reference to a `[u8]`.
pub struct FileBytesRefWr<'a>(&'a [u8]);
impl<'a> WriteTo for FileBytesRefWr<'a> {
fn write_to(&self, path: &Path) -> Result<()> {
utils::create_parent_dir(path)?;
std::fs::write(path, self.0).wrap_io_error_with(path)?;
Ok(())
}
}
/// A newtype around a [`String`].
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FileString(pub String);
impl FileString {
/// Creates a new [`FileString`] from the specified [`String`].
pub fn new(s: impl Into<String>) -> Self {
Self(s.into())
}
}
impl From<FileString> for String {
fn from(value: FileString) -> Self {
value.0
}
}
impl NewtypeToInner for FileString {
type Inner = String;
fn into_inner(self) -> Self::Inner {
self.0
}
}
impl ReadFrom for FileString {
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
std::fs::read_to_string(path)
.wrap_io_error_with(path)
.map(Self)
}
}
impl WriteTo for FileString {
fn write_to(&self, path: &Path) -> Result<()> {
Self::from_ref_for_writer(&self.0).write_to(path)
}
}
impl<'a> FromRefForWriter<'a> for FileString {
type Inner = str;
type Wr = FileStrWr<'a>;
fn from_ref_for_writer(value: &'a Self::Inner) -> Self::Wr {
FileStrWr(value)
}
}
/// The [`WriteTo`] wrapper around a reference to a [`str`].
pub struct FileStrWr<'a>(&'a str);
impl WriteTo for FileStrWr<'_> {
fn write_to(&self, path: &Path) -> Result<()> {
FileBytes::from_ref_for_writer(self.0.as_bytes()).write_to(path)
}
}
impl<T> ReadFrom for Option<T>
where
T: ReadFrom,
{
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
if path.exists() {
T::read_from(path).map(Some)
} else {
Ok(None)
}
}
}
impl<T> WriteTo for Option<T>
where
T: WriteTo,
{
fn write_to(&self, path: &Path) -> Result<()> {
if let Some(v) = self {
v.write_to(path)
} else {
Ok(())
}
}
}
/// A wrapper that defers the reading of a file until it is actually needed.
#[derive(Debug, Clone, Hash)]
pub struct DeferredRead<T>(pub PathBuf, std::marker::PhantomData<T>)
where
T: ReadFrom;
impl<T> ReadFrom for DeferredRead<T>
where
T: ReadFrom,
{
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
Ok(Self(path.to_path_buf(), std::marker::PhantomData))
}
}
impl<T> DeferredRead<T>
where
T: ReadFrom,
{
/// Performs the read and returns the value.
pub fn perform_read(&self) -> Result<T> {
T::read_from(&self.0)
}
}
impl<T> WriteTo for DeferredRead<T>
where
T: ReadFrom + WriteTo,
{
fn write_to(&self, path: &Path) -> Result<()> {
let r = self.perform_read()?;
r.write_to(path)
}
}
/// A wrapper that defers the reading of a file until it is actually needed.
///
/// It can also store the value.
#[derive(Debug, Clone, Hash)]
pub enum DeferredReadOrOwn<T>
where
T: ReadFrom,
{
Own(T),
Deferred(DeferredRead<T>),
}
impl<T> DeferredReadOrOwn<T>
where
T: ReadFrom,
{
/// Gets the value. If it is not already read, it will read it, but without saving it.
pub fn get(&self) -> Result<T>
where
T: Clone,
{
match self {
DeferredReadOrOwn::Own(own) => Ok(own.clone()),
DeferredReadOrOwn::Deferred(d) => Ok(d.perform_read()?),
}
}
/// Performs the read and stores the value. If the value is already read, it will
/// just return a reference to it.
pub fn perform_and_store_read(&mut self) -> Result<&T> {
match self {
DeferredReadOrOwn::Own(own) => Ok(own),
DeferredReadOrOwn::Deferred(d) => {
let value = d.perform_read()?;
*self = DeferredReadOrOwn::Own(value);
let DeferredReadOrOwn::Own(own) = self else {
unreachable!()
};
Ok(own)
}
}
}
}
impl<T> ReadFrom for DeferredReadOrOwn<T>
where
T: ReadFrom,
{
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
ReadFrom::read_from(path).map(Self::Deferred)
}
}
impl<T> WriteTo for DeferredReadOrOwn<T>
where
T: ReadFrom + WriteTo,
{
fn write_to(&self, path: &Path) -> Result<()> {
match self {
DeferredReadOrOwn::Own(own) => own.write_to(path),
DeferredReadOrOwn::Deferred(d) => d.write_to(path),
}
}
}
// Impls for std types.
impl ReadFrom for String {
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
FileString::read_from(path).map(|v| v.0)
}
}
impl WriteTo for String {
fn write_to(&self, path: &Path) -> Result<()> {
FileString::from_ref_for_writer(self).write_to(path)
}
}
impl ReadFrom for Vec<u8> {
fn read_from(path: &Path) -> Result<Self>
where
Self: Sized,
{
FileBytes::read_from(path).map(|v| v.0)
}
}
impl WriteTo for Vec<u8> {
fn write_to(&self, path: &Path) -> Result<()> {
FileBytes::from_ref_for_writer(self).write_to(path)
}
}
impl WriteTo for str {
fn write_to(&self, path: &Path) -> Result<()> {
FileStrWr(self).write_to(path)
}
}
impl<'a> WriteTo for &'a str {
fn write_to(&self, path: &Path) -> Result<()> {
FileStrWr(self).write_to(path)
}
}
impl WriteTo for [u8] {
fn write_to(&self, path: &Path) -> Result<()> {
FileBytesRefWr(self).write_to(path)
}
}
impl<'a> WriteTo for &'a [u8] {
fn write_to(&self, path: &Path) -> Result<()> {
FileBytesRefWr(self).write_to(path)
}
}
mod utils {
use crate::WrapIoError;
pub fn create_parent_dir(path: &std::path::Path) -> crate::Result<()> {
if let Some(parent) = path.parent() {
if !parent.exists() {
std::fs::create_dir_all(parent).wrap_io_error_with(parent)?;
}
}
Ok(())
}
}