garbage-fs 0.1.0

Abstraction layer for filesystems
Documentation 
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

pub mod stdfs;

#[cfg(test)]
pub mod mock;

use std::fs::Metadata;
use std::io::{ErrorKind, Result as IoResult, Write};
use std::path::{Path, PathBuf};

/// Abstraction for all filesystem operations
pub trait Filesystem {
  type File: File;

  fn create_dir<P: AsRef<Path>>(&self, path: P) -> IoResult<()>;

  fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> IoResult<()>;

  fn rename<P: AsRef<Path>, Q: AsRef<Path>>(
    &self,
    from: P,
    to: Q,
  ) -> IoResult<()>;

  fn remove_file<P: AsRef<Path>>(&self, path: P) -> IoResult<()>;

  fn remove_dir_all<P: AsRef<Path>>(&self, path: P) -> IoResult<()>;

  fn read_link<P: AsRef<Path>>(&self, path: P) -> IoResult<PathBuf>;

  fn path_metadata<P: AsRef<Path>>(&self, path: P) -> IoResult<Metadata>;

  fn symlink_metadata<P: AsRef<Path>>(&self, path: P) -> IoResult<Metadata>;

  fn file_metadata(&self, file: &Self::File) -> IoResult<Metadata>;

  fn path_exists<P: AsRef<Path>>(&self, path: P) -> IoResult<bool>;

  /// Check if a path exists WITHOUT resolving symlinks.
  fn symlink_exists<P: AsRef<Path>>(&self, path: P) -> IoResult<bool> {
    match self.symlink_metadata(path) {
      Ok(_) => Ok(true),
      Err(err) if matches!(err.kind(), ErrorKind::NotFound) => Ok(false),
      Err(err) => Err(err.into()),
    }
  }

  // File stuff

  /// File::open
  fn open_file<P: AsRef<Path>>(&self, path: P) -> IoResult<Self::File>;

  /// File::create
  fn create_file<P: AsRef<Path>>(&self, path: P) -> IoResult<Self::File>;
}

/// Abstraction for all file operations
pub trait File: Write {}