Struct Filesystem 

pub struct Filesystem { /* private fields */ }

Dependency client for small read and write file operations.

This client intentionally mirrors the corresponding std::fs helpers instead of modeling a full virtual file system.

Examples

use std::time::{SystemTime, UNIX_EPOCH};

let filesystem = clients::get::<clients::Filesystem>();
let unique = SystemTime::now()
    .duration_since(UNIX_EPOCH)
    .expect("system time should be after the unix epoch")
    .as_nanos();
let path = std::env::temp_dir().join(format!("clients-doc-filesystem-{unique}.txt"));

filesystem
    .write_string(path.clone(), "hello".to_string())
    .expect("write should succeed");
assert_eq!(
    filesystem.read_string(path.clone()).expect("read should succeed"),
    "hello"
);

std::fs::remove_file(path).expect("temp file should be removable");

Implementations

impl Filesystem

pub fn read(&self, path: PathBuf) -> Result<Vec<u8>, IoError>

Reads the file at path into memory as raw bytes.

pub fn read_string(&self, path: PathBuf) -> Result<String, IoError>

Reads the file at path into memory as a UTF-8 string.

pub fn write(&self, path: PathBuf, contents: Vec<u8>) -> Result<(), IoError>

Writes contents to path, replacing any existing file.

pub fn write_string( &self, path: PathBuf, contents: String, ) -> Result<(), IoError>

Writes contents to path, replacing any existing file.

Trait Implementations

impl Clone for Filesystem

fn clone(&self) -> Filesystem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Filesystem

fn default() -> Self

Returns the “default value” for a type.

impl Dependency for Filesystem

fn live() -> Self

Returns the live value for this dependency type.

impl Copy for Filesystem