odcs 0.9.1

Reference implementation of the Open Data Contract Standard (ODCS)
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

//! Local contract registry for discovery and cross-file validation.

mod entry;
mod local;
mod scan;

pub use entry::RegistryEntry;
pub use local::{Registry, MAX_REGISTRY_INDEX_BYTES};
pub use scan::{collect_contract_files_recursive, is_contract_file, MAX_REGISTRY_CONTRACT_FILES};

use std::path::Path;

use crate::diagnostics::DiagnosticReport;

/// Scan a directory recursively and build a registry index in memory.
pub fn index_registry(dir: &Path) -> Result<(Registry, DiagnosticReport), DiagnosticReport> {
    Registry::index_directory(dir)
}

/// Scan a directory and write `<dir>/.odcs/registry.json`.
pub fn index_and_save_registry(
    dir: &Path,
) -> Result<(Registry, DiagnosticReport), DiagnosticReport> {
    Registry::index_and_save(dir)
}

/// Load a registry from `<dir>/.odcs/registry.json`.
pub fn load_registry(dir: &Path) -> Result<Registry, DiagnosticReport> {
    Registry::load(dir)
}