Struct PortPicker

pub struct PortPicker { /* private fields */ }

PortPicker is a simple library to pick a free port in the local machine.

It can be used to find a free port to start a server or any other use case.

#Examples:

use random_port::PortPicker;
let port = PortPicker::new().pick().unwrap();
println!("The free port is {}", port);

Implementations

impl PortPicker

pub fn new() -> Self

pub fn port_range(self, range: RangeInclusive<u16>) -> Self

Specifies the range of ports to check. Must be in the range 1024..=65535. E.g. port_range(1024..=65535).

pub fn execlude(self, exclude: HashSet<u16>) -> Self

Specifies the ports to exclude.

pub fn execlude_add(self, port: u16) -> Self

Specifies a port to exclude.

pub fn protocol(self, protocol: Protocol) -> Self

Specifies the protocol to check, Default is Protocol::All. Can be either Protocol::Tcp, Protocol::Udp or Protocol::All.

pub fn host(self, host: String) -> Self

Specifies the host to check. Can be either an Ipv4 or Ipv6 address. If not specified, will checks availability on all local addresses defined in the system.

pub fn random(self, random: bool) -> Self

Specifies whether to pick a random port from the range. If not specified, will pick the first available port from the range.

pub fn pick(&self) -> Result<u16>