mirror of
https://github.com/nushell/nushell.git
synced 2025-06-05 09:36:44 +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)
102 lines
2.8 KiB
Rust
102 lines
2.8 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Span, Type, Value};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"math ln"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math ln")
|
|
.input_output_types(vec![(Type::Number, Type::Float)])
|
|
.vectorizes_over_list(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Returns the natural logarithm. Base: (math e)."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["natural", "logarithm", "inverse", "euler"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
// This doesn't match explicit nulls
|
|
if matches!(input, PipelineData::Empty) {
|
|
return Err(ShellError::PipelineEmpty { dst_span: head });
|
|
}
|
|
input.map(
|
|
move |value| operate(value, head),
|
|
engine_state.ctrlc.clone(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Get the natural logarithm of e",
|
|
example: "math e | math ln",
|
|
result: Some(Value::test_float(1.0f64)),
|
|
}]
|
|
}
|
|
}
|
|
|
|
fn operate(value: Value, head: Span) -> Value {
|
|
match value {
|
|
numeric @ (Value::Int { .. } | Value::Float { .. }) => {
|
|
let (val, span) = match numeric {
|
|
Value::Int { val, span } => (val as f64, span),
|
|
Value::Float { val, span } => (val, span),
|
|
_ => unreachable!(),
|
|
};
|
|
|
|
if val > 0.0 {
|
|
let val = val.ln();
|
|
|
|
Value::Float { val, span }
|
|
} else {
|
|
Value::Error {
|
|
error: ShellError::UnsupportedInput(
|
|
"'ln' undefined for values outside the open interval (0, Inf).".into(),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
),
|
|
}
|
|
}
|
|
}
|
|
Value::Error { .. } => value,
|
|
other => Value::Error {
|
|
error: ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "numeric".into(),
|
|
wrong_type: other.get_type().to_string(),
|
|
dst_span: head,
|
|
src_span: other.expect_span(),
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|