use-ip 0.1.0

Lightweight IP address parsing and classification helpers for RustUse.
Documentation 
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

use std::net::IpAddr;

/// Classifies a parsed IP literal.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum IpKind {
    /// IPv4 address literal.
    V4,
    /// IPv6 address literal.
    V6,
    /// Unknown or invalid input.
    Unknown,
}

/// Stores an original IP-like input with its detected kind.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IpParts {
    /// Original input value.
    pub input: String,
    /// Detected IP kind.
    pub kind: IpKind,
}

fn parse_ip(input: &str) -> Option<IpAddr> {
    let trimmed = input.trim();

    if trimmed.is_empty() {
        return None;
    }

    trimmed.parse().ok()
}

/// Returns `true` when the input is a valid IPv4 or IPv6 literal.
pub fn is_ip(input: &str) -> bool {
    parse_ip(input).is_some()
}

/// Returns `true` when the input is a valid IPv4 literal.
pub fn is_ipv4(input: &str) -> bool {
    matches!(parse_ip(input), Some(IpAddr::V4(_)))
}

/// Returns `true` when the input is a valid IPv6 literal.
pub fn is_ipv6(input: &str) -> bool {
    matches!(parse_ip(input), Some(IpAddr::V6(_)))
}

/// Detects whether the input is IPv4, IPv6, or unknown.
pub fn detect_ip_kind(input: &str) -> IpKind {
    match parse_ip(input) {
        Some(IpAddr::V4(_)) => IpKind::V4,
        Some(IpAddr::V6(_)) => IpKind::V6,
        None => IpKind::Unknown,
    }
}

/// Normalizes a valid IP literal to Rust's canonical string form.
pub fn normalize_ip(input: &str) -> Option<String> {
    parse_ip(input).map(|address| address.to_string())
}

/// Returns `true` when the input is a loopback IP literal.
pub fn is_loopback_ip(input: &str) -> bool {
    parse_ip(input).is_some_and(|address| address.is_loopback())
}

/// Returns `true` when the input is an unspecified IP literal.
pub fn is_unspecified_ip(input: &str) -> bool {
    parse_ip(input).is_some_and(|address| address.is_unspecified())
}

/// Returns `true` when the input is a private IPv4 or unique-local IPv6 literal.
pub fn is_private_ip(input: &str) -> bool {
    match parse_ip(input) {
        Some(IpAddr::V4(address)) => address.is_private(),
        Some(IpAddr::V6(address)) => address.is_unique_local(),
        None => false,
    }
}

/// Returns `true` when the input is a link-local IPv4 or IPv6 literal.
pub fn is_link_local_ip(input: &str) -> bool {
    match parse_ip(input) {
        Some(IpAddr::V4(address)) => address.is_link_local(),
        Some(IpAddr::V6(address)) => address.is_unicast_link_local(),
        None => false,
    }
}

/// Returns `true` when the input is a multicast IP literal.
pub fn is_multicast_ip(input: &str) -> bool {
    parse_ip(input).is_some_and(|address| address.is_multicast())
}