evault-core 0.1.0

Core types, traits, and services for evault.
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

//! [`ManifestIo`] — load and save project manifests on disk.

use std::path::Path;

use crate::error::ManifestError;
use crate::model::ManifestSnapshot;

/// Read and write `evault.toml` project manifests.
///
/// The wire format is owned by `evault-manifest`; this trait abstracts the
/// IO and parsing so the rest of the workspace can speak in
/// [`ManifestSnapshot`] values.
pub trait ManifestIo: Send + Sync {
    /// Load the manifest at `path` and parse it into a snapshot.
    ///
    /// # Errors
    /// Returns [`ManifestError::NotFound`] if the file does not exist;
    /// [`ManifestError::Parse`] if the file is malformed;
    /// [`ManifestError::Invalid`] if the contents violate semantic rules.
    fn load(&self, path: &Path) -> Result<ManifestSnapshot, ManifestError>;

    /// Serialize `snapshot` and write it to `path`, atomically replacing any
    /// existing file at that location.
    ///
    /// # Errors
    /// Returns [`ManifestError::Write`] if the write or rename fails.
    fn save(&self, path: &Path, snapshot: &ManifestSnapshot) -> Result<(), ManifestError>;
}