bonds-core 0.1.6

Core library for managing symlink-based bonds with SQLite persistence
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
31
32
33
34
35
36
37
38
39

//! # bonds-core
//!
//! Core library for creating and managing bonds (symlink-based directory links)
//! backed by SQLite persistence.
//!
//! ## Quick example
//! ```no_run
//! use bonds_core::{BondError, BondManager};
//! use std::path::PathBuf;
//!
//! // `BondManager::new(None)` uses ~/.bonds/bonds.db by default.
//! let manager = BondManager::new(None)?;
//! let source = PathBuf::from("/path/to/source");
//! let target = PathBuf::from("/path/to/target-link");
//!
//! // This creates a symlink on disk and persists the record in SQLite.
//! let _bond = manager.create_bond(source, target, Some("my-bond".to_string()))?;
//! # Ok::<(), BondError>(())
//! ```

/// Bond domain model types (for example, `Bond`).
pub mod bond;
/// User configuration loading/saving (`~/.bonds/config.toml`).
pub mod config;
/// Public error types returned by this crate.
pub mod error;
/// Event and hook types for lifecycle notifications.
pub mod events;
/// High-level manager for bond lifecycle operations.
pub mod manager;
/// Query builder types for filtering bonds.
pub mod query;

pub use bond::Bond;
pub use config::BondsConfig;
pub use error::{BondError, ErrorKind};
pub use events::{BondBrokenReason, BondEvent, BondEventHook, BondEventKind, BondEventPayload};
pub use manager::BondManager;
pub use query::{BondQuery, MetadataFilter};