turbovault_core/
lib.rs

1//! # TurboVault Core
2//!
3//! Core data models, error types, and configuration for the Obsidian vault management system.
4//! This crate defines the canonical types that all other crates depend on.
5//!
6//! ## Architecture Principles
7//!
8//! - **No External Crate Dependencies Beyond Serialization**: Only serde + basic Rust stdlib
9//! - **Type-Driven Design**: Strong types replace string-based APIs
10//! - **Zero Panic in Libraries**: All errors are Result<T, ObsidianError>
11//! - **Builder Pattern for Complex Types**: Configuration structs use builders
12//! - **Immutable by Default**: Mutation through explicit methods only
13//!
14//! ## Core Modules
15//!
16//! - [`models`] - Core vault data types (VaultFile, Link, Frontmatter, etc.)
17//! - [`error`] - Comprehensive error types and Result aliases
18//! - [`config`] - Server and vault configuration structures
19//! - [`validation`] - Content validation framework
20//! - [`metrics`] - Performance monitoring and statistics
21//! - [`multi_vault`] - Multi-vault management support
22//! - [`profiles`] - Configuration profiles for different environments
23//! - [`utils`] - Utility functions and builders
24//!
25//! ## Usage Examples
26//!
27//! ### Working with Vault Files
28//!
29//! ```
30//! use turbovault_core::prelude::*;
31//! use std::path::PathBuf;
32//!
33//! // Create a vault file metadata
34//! let metadata = FileMetadata {
35//!     path: PathBuf::from("my-note.md"),
36//!     size: 1024,
37//!     created_at: 0.0,
38//!     modified_at: 1234567890.0,
39//!     checksum: "abc123".to_string(),
40//!     is_attachment: false,
41//! };
42//! ```
43//!
44//! ### Error Handling
45//!
46//! ```
47//! use turbovault_core::prelude::*;
48//! use std::path::PathBuf;
49//!
50//! fn process_vault() -> Result<()> {
51//!     // All operations return Result<T>
52//!     let _path = PathBuf::from("vault.md");
53//!     // Error handling with type-safe error variants
54//!     let _err = Error::parse_error("Invalid markdown content");
55//!     Ok(())
56//! }
57//! ```
58//!
59//! ### Configuration
60//!
61//! ```
62//! use turbovault_core::prelude::*;
63//!
64//! let config = ServerConfig::default();
65//! // Access configuration properties safely
66//! let _config_has_vaults = !config.vaults.is_empty();
67//! ```
68//!
69//! ## Type Safety
70//!
71//! The core types use enums and strong types instead of strings:
72//!
73//! - [`LinkType`] - Distinguishes wikilinks, embeds, markdown links, etc.
74//! - [`Severity`] - Validation issue severity levels
75//! - [`models`] - Rich data models with position tracking
76
77pub mod config;
78pub mod error;
79pub mod metrics;
80pub mod models;
81pub mod multi_vault;
82pub mod profiles;
83pub mod resilience;
84pub mod utils;
85pub mod validation;
86pub mod cache;
87
88pub use config::*;
89pub use error::{Error, Result};
90pub use metrics::{Counter, Histogram, HistogramStats, HistogramTimer, MetricsContext};
91pub use models::*;
92pub use multi_vault::{MultiVaultManager, VaultInfo};
93pub use profiles::ConfigProfile;
94pub use utils::{CSVBuilder, PathValidator, TransactionBuilder, to_json_string};
95pub use validation::{
96    CompositeValidator, ContentValidator, FrontmatterValidator, LinkValidator, Severity,
97    ValidationIssue, ValidationReport, ValidationSummary, Validator,
98};
99
100/// Re-export commonly used types
101pub mod prelude {
102    pub use crate::config::{ServerConfig, VaultConfig};
103    pub use crate::error::{Error, Result};
104    pub use crate::metrics::{Counter, Histogram, MetricsContext};
105    pub use crate::models::{
106        Block, Callout, FileMetadata, Frontmatter, Heading, Link, LinkType, SourcePosition, Tag,
107        TaskItem, VaultFile,
108    };
109    pub use crate::multi_vault::{MultiVaultManager, VaultInfo};
110    pub use crate::profiles::ConfigProfile;
111    pub use crate::validation::{
112        CompositeValidator, ContentValidator, FrontmatterValidator, LinkValidator, Severity,
113        ValidationIssue, ValidationReport, Validator,
114    };
115}
turbovault_core/lib.rs

turbovault_core/
lib.rs
