31 lines
779 B
Rust
31 lines
779 B
Rust
//! Utilities asserting that the data being worked on is sound and well formatted.
|
||
//!
|
||
//! This module provides simple helpers that validate file system paths.
|
||
//!
|
||
//!
|
||
|
||
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
|
||
|
||
use std::path::Path;
|
||
|
||
use crate::error::EpochError;
|
||
|
||
/// Check whether `path` points to a valid Epoch directory.
|
||
///
|
||
/// A *valid* directory is one that satisfies the expectations of the `epoch` format.
|
||
pub fn is_a_epoch_directory(_path: &Path) -> Result<(), EpochError> {
|
||
todo!()
|
||
}
|
||
|
||
/// Validate that the configuration file at `path` is well‑formed.
|
||
pub fn is_config_well_formated(_path: &Path) -> Result<(), EpochError> {
|
||
todo!()
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod test {
|
||
#![allow(dead_code)]
|
||
fn test_directory() {}
|
||
fn test_config() {}
|
||
}
|