Struct OsFs 

pub struct OsFs;

Filesystem implementation that delegates to std::fs.

Every io::Error is wrapped with the path that caused it via DodotError::Fs.

Implementations

impl OsFs

pub fn new() -> Self

Trait Implementations

impl Clone for OsFs

fn clone(&self) -> OsFs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OsFs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OsFs

fn default() -> Self

Returns the “default value” for a type.

impl Fs for OsFs

fn stat(&self, path: &Path) -> Result<FsMetadata>

Returns metadata for the path, following symlinks.

fn lstat(&self, path: &Path) -> Result<FsMetadata>

Returns metadata for the path without following symlinks.

fn open_read(&self, path: &Path) -> Result<Box<dyn Read + Send + Sync>>

Opens the file for reading in a streaming fashion.

fn read_file(&self, path: &Path) -> Result<Vec<u8>>

Reads the entire file into bytes.

fn read_to_string(&self, path: &Path) -> Result<String>

Reads the entire file as a UTF-8 string.

fn write_file(&self, path: &Path, contents: &[u8]) -> Result<()>

Writes contents to path, creating or truncating the file.

fn mkdir_all(&self, path: &Path) -> Result<()>

Creates path and all parent directories.

fn symlink(&self, original: &Path, link: &Path) -> Result<()>

Creates a symbolic link at link pointing to original.

fn readlink(&self, path: &Path) -> Result<PathBuf>

Reads the target of a symbolic link.

fn remove_file(&self, path: &Path) -> Result<()>

Removes a file or symlink (not a directory).

fn remove_dir_all(&self, path: &Path) -> Result<()>

Removes a directory and all of its contents.

fn exists(&self, path: &Path) -> bool

Returns true if path exists (follows symlinks).

fn is_symlink(&self, path: &Path) -> bool

Returns true if path is a symlink (does not follow).

fn is_dir(&self, path: &Path) -> bool

Returns true if path is a directory (follows symlinks).

fn read_dir(&self, path: &Path) -> Result<Vec<DirEntry>>

Lists entries in a directory, sorted by name.

fn rename(&self, from: &Path, to: &Path) -> Result<()>

Renames (moves) from to to.

fn copy_file(&self, from: &Path, to: &Path) -> Result<()>

Copies a file from from to to.

fn set_permissions(&self, path: &Path, mode: u32) -> Result<()>

Sets file permissions (Unix mode).

fn modified(&self, path: &Path) -> Result<SystemTime>

Returns the modification time of path (follows symlinks). Used by dodot refresh to compare deployed-side mtimes against source-side mtimes when deciding whether to touch the source.

fn set_modified(&self, path: &Path, time: SystemTime) -> Result<()>

Sets the modification time of path to time. Used by dodot refresh to copy the deployed file’s mtime onto the template source so git’s stat-cache invalidates and the next git status re-reads the file (invoking the clean filter on repos that have it installed).

impl Copy for OsFs