domain_check_lib/lib.rs
1//! # Domain Check Library
2//!
3//! A fast, robust library for checking domain availability using RDAP and WHOIS protocols.
4//!
5//! This library provides both high-level and low-level APIs for domain availability checking,
6//! with support for concurrent processing, multiple protocols, and comprehensive error handling.
7//!
8//! ## Quick Start
9//!
10//! ```rust,no_run
11//! use domain_check_lib::{DomainChecker, CheckConfig};
12//!
13//! #[tokio::main]
14//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
15//! let checker = DomainChecker::new();
16//! let result = checker.check_domain("example.com").await?;
17//!
18//! println!("Domain: {} - Available: {:?}", result.domain, result.available);
19//! Ok(())
20//! }
21//! ```
22//!
23//! ## Features
24//!
25//! - **RDAP Protocol**: Modern registration data access protocol
26//! - **WHOIS Fallback**: Automatic fallback when RDAP is unavailable
27//! - **Concurrent Processing**: Efficient parallel domain checking
28//! - **Bootstrap Registry**: Dynamic RDAP endpoint discovery
29//! - **Configurable**: Extensive configuration options
30
31// Re-export main public API types and functions
32// This makes them available as domain_check_lib::TypeName
33pub use checker::DomainChecker;
34pub use config::{load_env_config, ConfigManager, FileConfig};
35pub use error::DomainCheckError;
36pub use protocols::registry::{
37 get_all_known_tlds, get_available_presets, get_preset_tlds, get_preset_tlds_with_custom,
38};
39pub use types::{CheckConfig, CheckMethod, DomainInfo, DomainResult, OutputMode};
40pub use utils::expand_domain_inputs;
41
42// Internal modules - these are not part of the public API
43mod checker;
44mod concurrent;
45mod config;
46mod error;
47mod protocols;
48mod types;
49mod utils;
50
51// Type alias for convenience
52pub type Result<T> = std::result::Result<T, DomainCheckError>;
53
54// Library version and metadata
55pub const VERSION: &str = env!("CARGO_PKG_VERSION");
56pub const AUTHOR: &str = env!("CARGO_PKG_AUTHORS");
57
58/// Initialize the library with default settings.
59///
60/// This function can be called to set up global state like logging,
61/// registry caches, etc. It's optional - the library will work without it.
62pub fn init() {
63 // Future: Initialize global caches, logging, etc.
64 // For now, this is a no-op but provides future extensibility
65}
66
67/// Get library information for debugging or display purposes.
68pub fn info() -> LibraryInfo {
69 LibraryInfo {
70 version: VERSION,
71 author: AUTHOR,
72 features: get_enabled_features(),
73 }
74}
75
76/// Information about the library build and features
77#[derive(Debug, Clone)]
78pub struct LibraryInfo {
79 pub version: &'static str,
80 pub author: &'static str,
81 pub features: Vec<&'static str>,
82}
83
84/// Get list of enabled features at compile time
85#[allow(clippy::vec_init_then_push)] // ← Add this line
86fn get_enabled_features() -> Vec<&'static str> {
87 let mut features = Vec::new();
88
89 #[cfg(feature = "rdap")]
90 features.push("rdap");
91
92 #[cfg(feature = "whois")]
93 features.push("whois");
94
95 #[cfg(feature = "bootstrap")]
96 features.push("bootstrap");
97
98 #[cfg(feature = "debug")]
99 features.push("debug");
100
101 features
102}