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 { 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 { 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 {}) } }