Crate port_check
source ·Expand description
§port_check
A simple rust library to get a free local port or to check if a port somewhere is reachable
Example:
use port_check::*;
use std::time::Duration;
// --------------------------------------------------------------------
// If not specified, all port checks are performed for IPv4 addresses.
// --------------------------------------------------------------------
// get a free local port
let free_port = free_local_port().unwrap();
// get a free local port between 10000 and 15000
let free_port_in_range = free_local_port_in_range(10000..=15000);
// check whether a remote port is reachable
let is_reachable = is_port_reachable("192.0.2.0:8080");
// or
let is_reachable = is_port_reachable_with_timeout("192.0.2.0:8080", Duration::from_millis(10_000));
// --------------------------------------------------------------------
// IPv6 checks are supported too
// --------------------------------------------------------------------
let free_ipv6_port = free_local_ipv6_port().unwrap();
let is_ipv6_port_free = is_local_port_free(Port::ipv6(free_ipv6_port));
// or
let is_ipv6_port_free = is_local_ipv6_port_free(free_ipv6_port);
Enums§
- Represents a port for an IP address
- Represents a port range for an IP address
Functions§
- Returns an available localhost port for IPv4
- Returns an available localhost port within the specified range for IPv4.
- Returns an available localhost port for IPv6
- Returns an available localhost port within the specified range for IPv6.
- Returns an available localhost port for IPv4
- Returns an available localhost port within the specified range. If the IP version is not specified, it defaults to IPv4. This happens when the port range is specified as a range.
- Returns whether a port is available on the localhost for IPv4
- Returns whether a port is available on the localhost for IPv6
- Returns whether a port is available on the localhost If the IP version is not specified, it defaults to IPv4. This happens when the port is specified as a number.
- Attempts a TCP connection to an address and returns whether it succeeded
- Attempts a TCP connection to an address and returns whether it succeeded