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 error::DomainCheckError;
35pub use protocols::registry::{get_all_known_tlds, get_available_presets, get_preset_tlds};
36pub use types::{CheckConfig, CheckMethod, DomainInfo, DomainResult, OutputMode};
37pub use utils::expand_domain_inputs;
38
39// Internal modules - these are not part of the public API
40mod checker;
41mod concurrent;
42mod error;
43mod protocols;
44mod types;
45mod utils;
46
47// Type alias for convenience
48pub type Result<T> = std::result::Result<T, DomainCheckError>;
49
50// Library version and metadata
51pub const VERSION: &str = env!("CARGO_PKG_VERSION");
52pub const AUTHOR: &str = env!("CARGO_PKG_AUTHORS");
53
54/// Initialize the library with default settings.
55///
56/// This function can be called to set up global state like logging,
57/// registry caches, etc. It's optional - the library will work without it.
58pub fn init() {
59 // Future: Initialize global caches, logging, etc.
60 // For now, this is a no-op but provides future extensibility
61}
62
63/// Get library information for debugging or display purposes.
64pub fn info() -> LibraryInfo {
65 LibraryInfo {
66 version: VERSION,
67 author: AUTHOR,
68 features: get_enabled_features(),
69 }
70}
71
72/// Information about the library build and features
73#[derive(Debug, Clone)]
74pub struct LibraryInfo {
75 pub version: &'static str,
76 pub author: &'static str,
77 pub features: Vec<&'static str>,
78}
79
80/// Get list of enabled features at compile time
81#[allow(clippy::vec_init_then_push)] // ← Add this line
82fn get_enabled_features() -> Vec<&'static str> {
83 let mut features = Vec::new();
84
85 #[cfg(feature = "rdap")]
86 features.push("rdap");
87
88 #[cfg(feature = "whois")]
89 features.push("whois");
90
91 #[cfg(feature = "bootstrap")]
92 features.push("bootstrap");
93
94 #[cfg(feature = "debug")]
95 features.push("debug");
96
97 features
98}