cmx-core 0.3.0

Embeddable core for installing agent skills across platforms — cmx-aware lockfile tracking, plan/apply installs, version guards
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

use anyhow::Result;
use std::path::{Path, PathBuf};

/// A simplified directory entry for the `Filesystem` trait boundary.
///
/// Uses a custom type (not `std::fs::DirEntry`) so that test fakes can
/// construct instances without touching the real filesystem.
pub struct DirEntry {
    pub path: PathBuf,
    pub file_name: String,
    pub is_dir: bool,
}

/// Abstraction over filesystem I/O operations used by cmx.
///
/// Every function that reads or writes files accepts `&dyn Filesystem` rather
/// than calling `std::fs` directly.  Production code uses `RealFilesystem`;
/// tests use the in-memory fake defined in [`super::fakes`].
pub trait Filesystem {
    fn exists(&self, path: &Path) -> bool;
    fn is_dir(&self, path: &Path) -> bool;
    fn is_file(&self, path: &Path) -> bool;
    fn read_to_string(&self, path: &Path) -> Result<String>;
    fn read(&self, path: &Path) -> Result<Vec<u8>>;
    fn write(&self, path: &Path, contents: &str) -> Result<()>;
    fn write_bytes(&self, path: &Path, contents: &[u8]) -> Result<()>;
    fn create_dir_all(&self, path: &Path) -> Result<()>;
    fn copy_file(&self, src: &Path, dest: &Path) -> Result<()>;
    /// Atomically rename `from` to `to`, replacing `to` if it already exists.
    fn rename(&self, from: &Path, to: &Path) -> Result<()>;
    fn remove_file(&self, path: &Path) -> Result<()>;
    fn remove_dir_all(&self, path: &Path) -> Result<()>;
    fn read_dir(&self, path: &Path) -> Result<Vec<DirEntry>>;
    fn canonicalize(&self, path: &Path) -> Result<PathBuf>;
}