mirror of
https://github.com/nushell/nushell.git
synced 2025-04-09 21:28:55 +02:00
bea7ec33c1
# Description I just updated a few examples linked to math commands. I used the character of pi where possible, and I updated one example since the example was misleading IMO (for the tau command). # User-Facing Changes Only examples have been updated, there is no real user changes. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
112 lines
3.1 KiB
Rust
112 lines
3.1 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 cos"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math cos")
|
|
.switch("degrees", "Use degrees instead of radians", Some('d'))
|
|
.input_output_types(vec![(Type::Number, Type::Float)])
|
|
.vectorizes_over_list(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Returns the cosine of the number."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["trigonometry"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let use_degrees = call.has_flag("degrees");
|
|
// This doesn't match explicit nulls
|
|
if matches!(input, PipelineData::Empty) {
|
|
return Err(ShellError::PipelineEmpty(head));
|
|
}
|
|
input.map(
|
|
move |value| operate(value, head, use_degrees),
|
|
engine_state.ctrlc.clone(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Apply the cosine to π",
|
|
example: "math pi | math cos",
|
|
result: Some(Value::test_float(-1f64)),
|
|
},
|
|
Example {
|
|
description: "Apply the cosine to a list of angles in degrees",
|
|
example: "[0 90 180 270 360] | math cos -d",
|
|
result: Some(Value::List {
|
|
vals: vec![
|
|
Value::test_float(1f64),
|
|
Value::test_float(0f64),
|
|
Value::test_float(-1f64),
|
|
Value::test_float(0f64),
|
|
Value::test_float(1f64),
|
|
],
|
|
span: Span::test_data(),
|
|
}),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
fn operate(value: Value, head: Span, use_degrees: bool) -> 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!(),
|
|
};
|
|
|
|
let val = if use_degrees { val.to_radians() } else { val };
|
|
|
|
Value::Float {
|
|
val: val.cos(),
|
|
span,
|
|
}
|
|
}
|
|
Value::Error { .. } => value,
|
|
other => Value::Error {
|
|
error: ShellError::OnlySupportsThisInputType(
|
|
"numeric".into(),
|
|
other.get_type().to_string(),
|
|
head,
|
|
other.expect_span(),
|
|
),
|
|
},
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|