obsidian_parser/lib.rs
1//! `obsidian-parser` - Blazingly fast Rust library for parsing and analyzing [Obsidian](https://obsidian.md) vaults
2//!
3//! Provides idiomatic APIs for:
4//! - Parsing individual Obsidian notes with frontmatter properties
5//! - Analyzing entire vaults as knowledge graphs
6//! - Extracting semantic relationships between notes
7//!
8//! ## Key Features
9//! * 🛡️ **100% Safe Rust** - Strictly forbids unsafe code (`#![forbid(unsafe_code)]`)
10//! * ⚡ **High Performance** - Parses 1000 notes in <3ms
11//! * 🕸️ **Knowledge Graphs** - Built-in petgraph integration for graph analysis (requires [`petgraph`] feature)
12//!
13//! ## Usage
14//! Add to `Cargo.toml`:
15//! ```toml
16//! [dependencies]
17//! obsidian-parser = { version = "0.3", features = ["petgraph", "rayon"] }
18//! ```
19//!
20//! ## Examples
21//!
22//! ### Basic Parsing
23//! ```no_run
24//! use obsidian_parser::prelude::*;
25//! use serde::Deserialize;
26//!
27//! // Parse single file with `HashMap`
28//! let note_hashmap = ObFileInMemory::from_file_default("note.md").unwrap();
29//!
30//! println!("Content: {}", note_hashmap.content().unwrap());
31//! println!("Properties: {:#?}", note_hashmap.properties().unwrap().unwrap());
32//!
33//! // Parse single file with custom struct
34//! #[derive(Clone, Deserialize)]
35//! struct NoteProperties {
36//! created: String,
37//! tags: Vec<String>,
38//! priority: u8,
39//! }
40//!
41//! let note_with_serde: ObFileInMemory<NoteProperties> = ObFileInMemory::from_file("note.md").unwrap();
42//! ```
43//!
44//! ### Vault Analysis
45//! ```no_run
46//! use obsidian_parser::prelude::*;
47//!
48//! // Load entire vault
49//! let vault = Vault::open_default("/path/to/vault").unwrap();
50//!
51//! // Check for duplicate note names
52//! if !vault.check_unique_note_name() {
53//! eprintln!("Duplicate note names detected!");
54//! }
55//!
56//! // Access parsed files
57//! for file in vault.files {
58//! println!("Note: {:?}", file.path());
59//! }
60//! ```
61//!
62//! ### Graph Analysis (requires [`petgraph`] feature)
63//! ```no_run
64//! #[cfg(feature = "petgraph")]
65//! {
66//! use obsidian_parser::prelude::*;
67//! use petgraph::dot::{Dot, Config};
68//!
69//! let vault = Vault::open_default("/path/to/vault").unwrap();
70//! let graph = vault.get_digraph().unwrap();
71//!
72//! // Export to Graphviz format
73//! println!("{:?}", Dot::with_config(&graph, &[Config::EdgeNoLabel]));
74//!
75//! // Find most connected note
76//! let most_connected = graph.node_indices()
77//! .max_by_key(|n| graph.edges(*n).count())
78//! .unwrap();
79//! println!("Knowledge hub: {}", graph[most_connected]);
80//! }
81//! ```
82//!
83//! ## Performance
84//! Optimized for large vaults:
85//! - 🚀 1000 files parsed in 2.7ms (avg)
86//! - 💾 Peak memory: 900KB per 1000 notes
87//!
88//! Parallel processing via Rayon (enable [`rayon`] feature)
89
90#![forbid(unsafe_code)]
91#![warn(missing_docs)]
92#![warn(clippy::pedantic)]
93#![warn(clippy::cargo)]
94#![warn(clippy::nursery)]
95#![warn(clippy::perf)]
96#![warn(clippy::unwrap_used)]
97#![warn(clippy::panic)]
98#![warn(clippy::needless_pass_by_value)]
99#![warn(clippy::unreadable_literal)]
100#![warn(clippy::missing_const_for_fn)]
101#![warn(clippy::as_conversions)]
102
103pub mod error;
104pub mod obfile;
105pub mod prelude;
106pub mod vault;
107
108#[cfg(test)]
109pub(crate) mod test_utils;