8 releases (4 breaking)

0.5.0 Jan 23, 2024
0.4.1 Apr 19, 2023
0.4.0 Mar 21, 2023
0.3.1 Oct 27, 2022
0.1.0 Mar 23, 2019

#1697 in Network programming

Download history 46/week @ 2024-03-09 21/week @ 2024-03-16 23/week @ 2024-03-23 78/week @ 2024-03-30 29/week @ 2024-04-06 21/week @ 2024-04-13 37/week @ 2024-04-20 5/week @ 2024-04-27 10/week @ 2024-05-04 10/week @ 2024-05-18 19/week @ 2024-05-25 36/week @ 2024-06-01 73/week @ 2024-06-08 89/week @ 2024-06-15 11/week @ 2024-06-22

212 downloads per month
Used in mc-server-pinger

MIT license

30KB
529 lines

craftping crates.io docs.rs license Actively Maintained

craftping is a Rust library to ping Minecraft Servers.

Usage

[dependencies]
craftping = "0.5.0"

You can synchronously ping to the server with craftping::sync::ping:

use std::net::TcpStream;
use craftping::sync::ping;

fn main() {
    let hostname = "localhost";
    let port = 25565;
    let mut stream = TcpStream::connect((hostname, port)).unwrap();
    let pong = ping(&mut stream, hostname, port).expect("Cannot ping server");
    println!("Ping result: {:?}", pong);
}

sync module requires sync feature, which is enabled by default.

If you want to send pings asynchronously, you can use craftping::tokio::ping or craftping::futures::ping:

  • craftping::tokio::ping
use tokio::net::TcpStream;
use craftping::tokio::ping;

#[tokio::main]
async fn main() {
    let hostname = "localhost";
    let port = 25565;
    let mut stream = TcpStream::connect((hostname, port)).await.unwrap();
    let pong = ping(&mut stream, hostname, port).await.expect("Cannot ping server");
    println!("Ping result: {:?}", pong);
}
  • craftping::futures::ping
use async_std::net::TcpStream;
use craftping::futures::ping;

#[async_std::main]
async fn main() {
    let hostname = "localhost";
    let port = 25565;
    let mut stream = TcpStream::connect((hostname, port)).await.unwrap();
    let pong = ping(&mut stream, hostname, port).await.expect("Cannot ping server");
    println!("Ping result: {:?}", pong);
}

Note that tokio module requires async-tokio feature and futures async-futures.

Check here for more information about ping result.

Contributing

Pull requests are welcome. For major issues, please open the issue on this repository first.

License

MIT

Dependencies

~0.9–3MB
~59K SLoC