rsword_chirho 0.3.0

Core SWORD module library in pure Rust
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

// For God so loved the world that he gave his only begotten Son,
// that whoever believes in him should not perish but have eternal life.
// John 3:16

//! Module management functionality.
//!
//! This module provides facilities for discovering, loading, and installing SWORD modules.
//!
//! ## Module Manager
//!
//! [`SwMgrChirho`] discovers and provides access to installed modules:
//!
//! ```rust,ignore
//! use rsword_chirho::SwMgrChirho;
//!
//! // Load from system paths
//! let mgr_chirho = SwMgrChirho::with_system_paths_chirho().unwrap();
//!
//! // List all modules
//! for name_chirho in mgr_chirho.get_module_names_chirho() {
//!     println!("Found: {}", name_chirho);
//! }
//!
//! // Get modules by type
//! let bibles_chirho = mgr_chirho.get_bibles_chirho();
//! let commentaries_chirho = mgr_chirho.get_commentaries_chirho();
//! let lexicons_chirho = mgr_chirho.get_lexicons_chirho();
//! ```
//!
//! ## Install Manager
//!
//! [`InstallMgrChirho`] handles downloading and installing modules from remote sources:
//!
//! ```rust,ignore
//! use rsword_chirho::manager_chirho::InstallMgrChirho;
//!
//! let mut install_mgr_chirho = InstallMgrChirho::new_chirho();
//!
//! // Initialize and sync with remote sources
//! install_mgr_chirho.init_chirho().unwrap();
//! install_mgr_chirho.sync_config_chirho().unwrap();
//!
//! // List available modules from a source
//! let modules_chirho = install_mgr_chirho.get_remote_modules_chirho("CrossWire").unwrap();
//! for module_chirho in modules_chirho {
//!     println!("{}: {}", module_chirho.name_chirho, module_chirho.description_chirho);
//! }
//!
//! // Install a module
//! install_mgr_chirho.install_module_chirho("CrossWire", "KJV").unwrap();
//! ```
//!
//! ## Module Factory
//!
//! [`load_module_chirho`] creates the appropriate driver for a module configuration:
//!
//! ```rust,ignore
//! use rsword_chirho::manager_chirho::{load_module_chirho, OutputFormatChirho};
//! use rsword_chirho::config_chirho::ModuleConfigChirho;
//! use std::path::Path;
//!
//! // Load config file
//! let config_chirho = ModuleConfigChirho::from_file_chirho(Path::new("kjv.conf")).unwrap();
//!
//! // Load the module with HTML output
//! let module_chirho = load_module_chirho(
//!     &config_chirho,
//!     Path::new("/usr/share/sword"),
//!     OutputFormatChirho::HtmlChirho,
//! ).unwrap();
//! ```

pub mod sw_mgr_chirho;
pub mod module_factory_chirho;

// Install manager requires native platform (filesystem + network)
#[cfg(feature = "native")]
pub mod install_mgr_chirho;

pub use sw_mgr_chirho::SwMgrChirho;

#[cfg(feature = "native")]
pub use install_mgr_chirho::{
    InstallMgrChirho, ModuleInfoChirho, ModuleUpdateChirho, SearchResultChirho,
};

pub use module_factory_chirho::{
    LoadedModuleChirho, ModuleDriverTypeChirho, OutputFormatChirho,
    CreateModuleOptionsChirho, GenBookWrapperChirho,
    load_module_chirho, create_module_chirho,
};