Language : 🇺🇸 English | 🇨🇳 简体中文

port-selector

Overview

port-selector is a rust library that provides port availability checking, port filtering based on conditions and occupy specified ports.

Installation

1. Get the latest version -> https://crates.io/crates/port-selector

2. Add the dependent toml [dependencies] port-selector = "0.1.5"

3. use ```rust use portselector::{isfree, Port};

fn main() { let checkport: Port = 3000; println!("isfree({}) = {}", checkport, isfree(check_port)); } ```

Goods

type -> Port · Selector

fn -> isfreetcp · isfreeudp · isfree · randomfreetcpport · randomfreeudpport · randomfreeport · selectfromgivenport · selectfreeport · takeuptcpport · takeupudpport · takeupport · randomtakeuptcpport · randomtakeupudpport · randomtakeup_port

Documentation

Port

u16 type alias rust pub type Port = u16;

Selector

The select_free_port requires a structure passed in rust pub struct Selector { // Check whether the port is available on TCP. // The default value is true. pub check_tcp: bool, // Check whether the port is available on UDP. // The default value is true. pub check_udp: bool, // Set the range of generated ports, default (0, 65525) pub port_range: (u16, u16), // Maximum number of random times. Default value: 100 // If no available port number is found within the maximum random number of loops, None is returned pub max_random_times: u16, }

is_free_tcp

Check whether the port is not used on TCP rust pub fn is_free_udp(port: Port) -> bool

is_free_udp

Check whether the port is not used on UDP rust pub fn is_free_udp(port: Port) -> bool

is_free

Check whether the port is not used on TCP and UDP rust pub fn is_free(port: Port) -> bool

random_free_tcp_port

The system randomly assigns available TCP ports rust pub fn random_free_tcp_port() -> Option<Port>

random_free_udp_port

The system randomly assigns available UDP ports rust pub fn random_free_udp_port() -> Option<Port>

random_free_port

The system randomly assigns available TCP and UDP ports rust pub fn random_free_port() -> Option<Port>

select_from_given_port

Check from given_port and return the first available port

Return if given_port is available; Otherwise given_port += 1 until the port is available rust pub fn select_from_given_port(given_port: Port) -> Option<Port>

select_free_port

Gets a matching port based on the Selector parameter constraint rust pub fn select_free_port(selector: Selector) -> Option<Port>

take_up_tcp_port

Occupy port on tcp rust fn take_up_tcp_port(port: Port) -> bool

take_up_udp_port

Occupy port on udp rust fn take_up_udp_port(port: Port) -> bool

take_up_port

Occupy port on tcp && udp rust fn take_up_port(port: Port) -> bool

random_take_up_tcp_port

Randomly occupied port on tcp by the system rust fn random_take_up_tcp_port() -> Port

random_take_up_udp_port

Randomly occupied port on udp by the system rust fn random_take_up_udp_port() -> Port

random_take_up_port

Randomly occupy tcp && udp ports by the system rust fn random_take_up_port() -> Port

Thanks

portpicker-rs