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

mod client;
mod config;
mod error;
mod icmp;
mod ping;

use std::net::IpAddr;

pub use client::Client;
pub use config::{Config, ConfigBuilder};
pub use error::SurgeError;
pub use icmp::{icmpv4::Icmpv4Packet, icmpv6::Icmpv6Packet, IcmpPacket};
pub use ping::Pinger;

#[derive(Debug, Clone, Copy)]
pub enum ICMP {
    V4,
    V6,
}

impl Default for ICMP {
    fn default() -> Self {
        ICMP::V4
    }
}

/// Shortcut method to quickly make a `Pinger`.
/// **NOTE**: This function creates a new internal `Client` on each call,
/// and so should not be used if making many target. Create a
/// [`Client`](./struct.Client.html) instead.
///
/// # Examples
///
/// ```rust
/// let mut pinger = surge_ping::pinger("8.8.8.8".parse()?).await?;
/// ```
///
/// # Errors
///
/// This function fails if:
///
/// - socket create failed
///
pub async fn pinger(host: IpAddr) -> Result<Pinger, SurgeError> {
    let config = match host {
        IpAddr::V4(_) => Config::default(),
        IpAddr::V6(_) => Config::builder().kind(ICMP::V6).build(),
    };
    let client = Client::new(&config).await?;
    let pinger = client.pinger(host).await;
    Ok(pinger)
}