ipflag 0.1.0

Human-friendly IP -> country flag display core (resolver-pluggable, no data bundled).
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

/// Errors produced by IP Flag APIs.
///
/// This crate can fail in two ways:
/// 1) IP parsing fails (`InvalidIp`)
/// 2) The user-provided resolver fails (`Resolver`)
///
/// The resolver error type is generic so that each resolver can expose its own
/// error enum without being forced into a boxed error.
///
/// # Example
///
/// ```rust
/// use ipflag::{IpflagError, tag_ip, NoopResolver};
///
/// let err = tag_ip(&NoopResolver, "not-an-ip").unwrap_err();
/// match err {
///     IpflagError::InvalidIp(_) => {}
///     _ => panic!("expected InvalidIp"),
/// }
/// ```
#[derive(Debug)]
pub enum IpflagError<E> {
    /// Invalid IP string (failed to parse into `std::net::IpAddr`).
    InvalidIp(std::net::AddrParseError),

    /// Resolver-specific error. Only possible for public IPs, because the resolver
    /// is never called for private/special addresses.
    Resolver(E),
}