openport 0.3.0

Find a free unused port
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
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

#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
#![allow(clippy::multiple_crate_versions)]
#![forbid(unsafe_code)]

//! Command-line interface for finding available network ports
//!
//! This binary provides a simple CLI to find available ports on the system.
//! It supports finding any available port (with the `rand` feature) or searching
//! within a specific port range (exclusive or inclusive).
//!
//! # Usage
//!
//! Find any available port (requires `rand` feature):
//! ```bash
//! openport
//! ```
//!
//! Find an available port in a range (exclusive):
//! ```bash
//! openport 15000 16000
//! ```
//!
//! Find an available port in a range (inclusive):
//! ```bash
//! openport 15000 16000 --inclusive
//! ```

use clap::Parser;
use std::process;

/// Find an available port on the system
#[derive(Parser)]
#[command(author, version, about, long_about = None)]
struct Cli {
    /// Start of the port range
    #[arg(value_name = "START")]
    start: Option<u16>,

    /// End of the port range
    #[arg(value_name = "END", requires = "start")]
    end: Option<u16>,

    /// Use inclusive range (includes the end port)
    #[arg(long)]
    inclusive: bool,
}

fn main() {
    let cli = Cli::parse();

    match (cli.start, cli.end) {
        (None, None) => {
            // No arguments - find any available port using rand feature
            #[cfg(feature = "rand")]
            {
                if let Some(port) = openport::pick_random_unused_port() {
                    println!("{port}");
                } else {
                    eprintln!("Error: No available ports found");
                    process::exit(1);
                }
            }
            #[cfg(not(feature = "rand"))]
            {
                eprintln!("Error: The 'rand' feature is required to find any available port");
                eprintln!("Please rebuild with: cargo build --features rand");
                process::exit(1);
            }
        }
        (Some(start), Some(end)) => {
            if start >= end {
                eprintln!("Error: Start port must be less than end port");
                process::exit(1);
            }

            let port = if cli.inclusive {
                openport::pick_unused_port(start..=end)
            } else {
                openport::pick_unused_port(start..end)
            };

            if let Some(port) = port {
                println!("{port}");
            } else {
                eprintln!("Error: No available ports found in range {start}..{end}");
                process::exit(1);
            }
        }
        _ => unreachable!("clap ensures START and END are provided together"),
    }
}