mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 23:54:26 +02:00
438062d7fc
# Description The `ShellError` enum at the moment is kind of messy. Many variants are basic tuple structs where you always have to reference the implementation with its macro invocation to know which field serves which purpose. Furthermore we have both variants that are kind of redundant or either overly broad to be useful for the user to match on or overly specific with few uses. So I set out to start fixing the lacking documentation and naming to make it feasible to critically review the individual usages and fix those. Furthermore we can decide to join or split up variants that don't seem to be fit for purpose. Feel free to add review comments if you spot inconsistent use of `ShellError` variants. - Name fields on `ShellError::OperatorOverflow` - Name fields on `ShellError::PipelineMismatch` - Add doc to `ShellError::OnlySupportsThisInputType` - Name `ShellError::OnlySupportsThisInputType` - Name field on `ShellError::PipelineEmpty` - Comment about issues with `TypeMismatch*` - Fix a few `exp_input_type`s - Name fields on `ShellError::InvalidRange` # User-Facing Changes (None now, end goal more explicit and consistent error messages) # Tests + Formatting (No additional tests needed so far)
104 lines
2.9 KiB
Rust
104 lines
2.9 KiB
Rust
use nu_engine::CallExt;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::IntoPipelineData;
|
|
use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4, TcpListener};
|
|
|
|
use nu_protocol::{
|
|
Category, Example, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"port"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("port")
|
|
.input_output_types(vec![(Type::Nothing, Type::Int)])
|
|
.optional(
|
|
"start",
|
|
SyntaxShape::Int,
|
|
"The start port to scan (inclusive)",
|
|
)
|
|
.optional("end", SyntaxShape::Int, "The end port to scan (inclusive)")
|
|
.category(Category::Network)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Get a free port from system."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["network", "http"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
get_free_port(engine_state, stack, call)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "get a free port between 3121 and 4000",
|
|
example: "port 3121 4000",
|
|
result: Some(Value::test_int(3121)),
|
|
},
|
|
Example {
|
|
description: "get a free port from system",
|
|
example: "port",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
fn get_free_port(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let start_port: Option<usize> = call.opt(engine_state, stack, 0)?;
|
|
let end_port: Option<usize> = call.opt(engine_state, stack, 1)?;
|
|
|
|
let listener = if start_port.is_none() && end_port.is_none() {
|
|
// get free port from system.
|
|
TcpListener::bind("127.0.0.1:0")?
|
|
} else {
|
|
let start_port = start_port.unwrap_or(1024);
|
|
let end_port = end_port.unwrap_or(65535);
|
|
|
|
// check input range valid.
|
|
if start_port > end_port {
|
|
return Err(ShellError::InvalidRange {
|
|
left_flank: start_port.to_string(),
|
|
right_flank: end_port.to_string(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
|
|
// try given port one by one.
|
|
let addrs: Vec<SocketAddr> = (start_port..=end_port)
|
|
.map(|current| {
|
|
SocketAddr::V4(SocketAddrV4::new(
|
|
Ipv4Addr::new(127, 0, 0, 1),
|
|
current as u16,
|
|
))
|
|
})
|
|
.collect();
|
|
TcpListener::bind(addrs.as_slice())?
|
|
};
|
|
|
|
let free_port = listener.local_addr()?.port();
|
|
Ok(Value::int(free_port as i64, call.head).into_pipeline_data())
|
|
}
|