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 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
//! Adds a fancy way to generate IP addresses and socket addresses from its
//! string representation
//!
//! This library aims to replace the use of `parse()` or `new()` functions for
//! initializing an IP address using a macro call. This approach allows the
//! emission of compile-time errors when an address is malformed and the use of
//! human-readable addresses in const contexts.
//!
//! # Using in `#[no_std]` contexts
//!
//! This library can be used in `#[no_std]` contexts by using the `core`
//! implementation of addresses instead of the `std` implementation.
//!
//! > ⚠️ Address in `core` is currently an unstable feature.
//! >
//! > In order to use this feature, you must use the nightly toolchain and
//! > enable the `ip_in_core` in `main.rs` or `lib.rs` as is:
//! > ```ignore
//! > #![feature(ip_in_core)]
//! > ```
//! >
//! > No external IP address provider is planned to be supported. If you want to
//! > use `fancy-ip` in `#[no_std]` context with the stable or beta toolchain:
//! > be patient.
//!
//! In order to use fancy-ip in `no_std` contexts, you must add this library in
//! your `Cargo.toml` disabling the default features:
//! ```toml
//! fancy-ip = { version = "0.1", default_features = false }
//! ```
#![crate_type = "proc-macro"]
extern crate proc_macro;
mod arg_parser;
use arg_parser::ArgParser;
use proc_macro_error::{abort, proc_macro_error};
use std::{
net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6},
str::FromStr,
};
use proc_macro::TokenStream;
#[cfg(feature = "std")]
const OBJECT_PREFIX: &'static str = "std::net";
#[cfg(not(feature = "std"))]
const OBJECT_PREFIX: &'static str = "core::net";
fn generate_ipv4_stream(addr: &Ipv4Addr) -> TokenStream {
let [a, b, c, d] = addr.octets();
format!("{OBJECT_PREFIX}::Ipv4Addr::new({a}, {b}, {c}, {d})")
.parse()
.unwrap()
}
fn generate_ipv4_socket_stream(socket: &SocketAddrV4) -> TokenStream {
let addr = socket.ip();
let port = socket.port();
let ip_stream = generate_ipv4_stream(addr);
format!("{OBJECT_PREFIX}::SocketAddrV4::new({ip_stream},{port})")
.parse()
.unwrap()
}
fn generate_ipv6_stream(addr: &Ipv6Addr) -> TokenStream {
let [a, b, c, d, e, f, g, h] = addr.segments();
format!("{OBJECT_PREFIX}::Ipv6Addr::new({a}, {b}, {c}, {d}, {e}, {f}, {g}, {h})")
.parse()
.unwrap()
}
fn generate_ipv6_socket_stream(socket: &SocketAddrV6) -> TokenStream {
let addr = socket.ip();
let port = socket.port();
let flow_info = socket.flowinfo();
let scope_id = socket.scope_id();
let ip_stream = generate_ipv6_stream(addr);
format!("{OBJECT_PREFIX}::SocketAddrV6::new({ip_stream},{port},{flow_info},{scope_id})")
.parse()
.unwrap()
}
fn generate_ip_stream(addr: &IpAddr) -> TokenStream {
match addr {
IpAddr::V4(ip) => {
let ip_stream = generate_ipv4_stream(ip);
format!("{OBJECT_PREFIX}::IpAddr::V4({ip_stream})")
.parse()
.unwrap()
},
IpAddr::V6(ip) => {
let ip_stream = generate_ipv6_stream(ip);
format!("{OBJECT_PREFIX}::IpAddr::V6({ip_stream})")
.parse()
.unwrap()
}
}
}
fn generate_ip_socket_stream(socket : &SocketAddr) -> TokenStream {
match socket {
SocketAddr::V4(socket) => {
let socket_stream = generate_ipv4_socket_stream(socket);
format!("{OBJECT_PREFIX}::SocketAddr::V4({socket_stream})")
.parse()
.unwrap()
},
SocketAddr::V6(socket) => {
let socket_stream = generate_ipv6_socket_stream(socket);
format!("{OBJECT_PREFIX}::SocketAddr::V6({socket_stream})")
.parse()
.unwrap()
}
}
}
/// Generate an IPv4 address from the standard textual representation
///
/// # Syntax
///
/// This macro works as a function which take only one argument: the string
/// representation of an IP address
///
/// # Example
///
/// ```
/// # use fancy_ip::ipv4;
///
/// assert_eq!(ipv4!("192.168.1.5"), std::net::Ipv4Addr::new(192, 168, 1, 5));
/// ```
#[proc_macro_error]
#[proc_macro]
pub fn ipv4(item: TokenStream) -> TokenStream {
let mut parser = ArgParser::from(item);
let ip = if let Some(v) = parser.next_string() {
Ipv4Addr::from_str(v.as_str()).unwrap()
} else {
abort!(
parser.last_span(),
"The first argument must be a string giving the IPv4 address only"
);
};
if !parser.is_end_reached() {
abort!(
parser.last_span(),
"Too many argument given, only expected the IP address"
);
}
generate_ipv4_stream(&ip)
}
/// Generate an IPv6 address from the standard textual representation
///
/// # Syntax
///
/// This macro works as a function which take only one argument: the string
/// representation of an IP address
///
/// # Example
///
/// ```
/// # use fancy_ip::ipv6;
///
/// assert_eq!(ipv6!("::1"), std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
/// ```
#[proc_macro_error]
#[proc_macro]
pub fn ipv6(item: TokenStream) -> TokenStream {
let mut parser = ArgParser::from(item);
let ip = if let Some(v) = parser.next_string() {
Ipv6Addr::from_str(v.as_str()).unwrap()
} else {
abort!(
parser.last_span(),
"The first argument must be a string giving the IPv6 address only"
);
};
if !parser.is_end_reached() {
abort!(
parser.last_span(),
"Too many argument given, only expected the IP address"
);
}
generate_ipv6_stream(&ip)
}
/// Generate an IP address from the standard textual representation (both
/// support IPv4 and IPv6)
///
/// # Syntax
///
/// This macro works as a function which take only one argument: the string
/// representation of an IP address
///
/// # Example
///
/// ```
/// # use fancy_ip::ip;
///
/// assert_eq!(ip!("::1"), std::net::IpAddr::V6(std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));
/// assert_eq!(ip!("192.168.1.5"), std::net::IpAddr::V4(std::net::Ipv4Addr::new(192, 168, 1, 5)));
/// ```
#[proc_macro_error]
#[proc_macro]
pub fn ip(item: TokenStream) -> TokenStream {
let mut parser = ArgParser::from(item);
let ip = if let Some(v) = parser.next_string() {
IpAddr::from_str(v.as_str()).unwrap()
} else {
abort!(
parser.last_span(),
"The first argument must be a string giving the IP address only"
);
};
if !parser.is_end_reached() {
abort!(
parser.last_span(),
"Too many argument given, only expected the IP address"
);
}
generate_ip_stream(&ip)
}
/// Generates a socket address from its string representation
///
/// # Syntax
///
/// This macro works as a function which take only one argument: the string
/// representation of a socket address
///
/// # Example
///
/// ```
/// # use fancy_ip::socketv4;
///
/// assert_eq!(socketv4!("192.168.1.5:3000"), std::net::SocketAddrV4::new(std::net::Ipv4Addr::new(192, 168, 1, 5), 3000));
/// ```
#[proc_macro_error]
#[proc_macro]
pub fn socketv4(item: TokenStream) -> TokenStream {
let mut parser = ArgParser::from(item);
let socket = if let Some(v) = parser.next_string() {
SocketAddrV4::from_str(v.as_str()).unwrap()
} else {
abort!(
parser.last_span(),
"The first argument must be a string giving the IPv4 address with optionnaly the port"
);
};
if !parser.is_end_reached() {
abort!(
parser.last_span(),
"Too many argument given, only expected the IP address"
);
}
generate_ipv4_socket_stream(&socket)
}
/// Generates a socket address from its string representation
///
/// # Syntax
///
/// This macro works as a function which take only one argument: the string
/// representation of a socket address
///
/// # Example
///
/// ```
/// # use fancy_ip::socketv6;
///
/// assert_eq!(socketv6!("[::1]:3000"), std::net::SocketAddrV6::new(std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 3000, 0, 0));
/// assert_eq!(socketv6!("[::]:8080", 58, 30), std::net::SocketAddrV6::new(std::net::Ipv6Addr::UNSPECIFIED, 8080, 58, 30));
/// ```
#[proc_macro_error]
#[proc_macro]
pub fn socketv6(item: TokenStream) -> TokenStream {
let mut parser = ArgParser::from(item);
let mut socket = if let Some(v) = parser.next_string() {
SocketAddrV6::from_str(v.as_str()).unwrap()
} else {
abort!(
parser.last_span(),
"The first argument must be a string giving the IPv6 address with optionnaly the port"
);
};
if !parser.is_end_reached() {
if let Some(flow_info) = parser.next_integer() {
socket.set_flowinfo(flow_info);
} else {
abort!(
parser.last_span(),
"The second argument must be a 32 bit integer giving the IPv6 flow info"
);
}
}
if !parser.is_end_reached() {
if let Some(scope_id) = parser.next_integer() {
socket.set_scope_id(scope_id)
} else {
abort!(
parser.last_span(),
"The third argument must be a 32 bit integer giving the IPv6 scope id"
);
}
}
if !parser.is_end_reached() {
abort!(
parser.last_span(),
"Too many argument given, only expected the IP address"
);
}
generate_ipv6_socket_stream(&socket)
}
/// Generates a socket address from its string representation
///
/// # Syntax
///
/// This macro works as a function which take only one argument: the string
/// representation of a socket address
///
/// # Example
///
/// ```
/// # use fancy_ip::socket;
///
/// assert_eq!(socket!("[::1]:3000"), std::net::SocketAddr::V6(std::net::SocketAddrV6::new(std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 3000, 0, 0)));
/// assert_eq!(socket!("192.168.1.5:3000"), std::net::SocketAddr::V4(std::net::SocketAddrV4::new(std::net::Ipv4Addr::new(192, 168, 1, 5), 3000)));
/// ```
#[proc_macro_error]
#[proc_macro]
pub fn socket(item: TokenStream) -> TokenStream {
let mut parser = ArgParser::from(item);
let socket = if let Some(v) = parser.next_string() {
SocketAddr::from_str(v.as_str()).unwrap()
} else {
abort!(
parser.last_span(),
"The first argument must be a string giving the IP address with optionnaly the port"
);
};
if !parser.is_end_reached() {
abort!(
parser.last_span(),
"Too many argument given, only expected the IP address"
);
}
generate_ip_socket_stream(&socket)
}