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
//! # Rust Minecraft Server Status Library
//!
//! A high-performance, asynchronous Rust library for querying the status of both
//! Minecraft Java Edition and Bedrock Edition servers.
//!
//! ## Features
//!
//! - **Dual Protocol Support**: Ping both Minecraft Java Edition (`25565`) and Bedrock Edition (`19132`) servers
//! - **Async/Await**: Built on Tokio for non-blocking operations and high concurrency
//! - **Batch Queries**: Ping multiple servers in parallel with configurable concurrency limits
//! - **DNS Caching**: Automatically caches DNS lookups and SRV records to reduce latency
//! - **SRV Record Support**: Automatically resolves SRV records for Java servers (mimics Minecraft client behavior)
//! - **Structured Data**: Returns richly structured, serializable data (using `serde`)
//! - **Favicon Handling**: Easily retrieve and save server favicons (Java Edition only)
//! - **Robust Error Handling**: Comprehensive error types using `thiserror`
//! - **Extended Information**: Detailed data about plugins, mods, DNS, and more
//!
//! ## Quick Start
//!
//! ```no_run
//! use rust_mc_status::{McClient, ServerEdition};
//! use std::time::Duration;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let client = McClient::new()
//! .with_timeout(Duration::from_secs(5))
//! .with_max_parallel(10);
//!
//! // Ping a Java server (automatically uses SRV lookup if port not specified)
//! let status = client.ping("mc.hypixel.net", ServerEdition::Java).await?;
//! println!("Server is online: {}", status.online);
//! if let Some((online, max)) = status.players() {
//! println!("Players: {}/{}", online, max);
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ## SRV Record Lookup
//!
//! When pinging Java servers without an explicit port, the library automatically performs
//! an SRV DNS lookup for `_minecraft._tcp.{hostname}`. This mimics the behavior of the
//! official Minecraft client.
//!
//! - If an SRV record is found, the target host and port from the record are used
//! - If no SRV record exists, the default port (25565) is used
//! - Explicitly specifying a port (e.g., `"server.com:25565"`) skips SRV lookup
//! - SRV lookup results are cached for 5 minutes to improve performance
//!
//! ## Examples
//!
//! See the `examples/` directory for more detailed usage examples.
//!
//! - `basic_usage.rs` - Basic server status queries
//! - `advanced_usage.rs` - Advanced features and batch queries
//! - `srv_lookup_example.rs` - SRV record lookup demonstration
//! - `performance_test.rs` - Performance benchmarking and speed tests
//! - `cache_management.rs` - Cache management and statistics
pub use McClient;
pub use McError;
pub use *;
// Re-export CacheStats for convenience
pub use CacheStats;