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)
108 lines
3.0 KiB
Rust
108 lines
3.0 KiB
Rust
use crate::input_handler::{operate, CellPathOnlyArgs};
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::ast::CellPath;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::Category;
|
|
use nu_protocol::{Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value};
|
|
|
|
#[derive(Clone)]
|
|
|
|
pub struct BytesReverse;
|
|
|
|
impl Command for BytesReverse {
|
|
fn name(&self) -> &str {
|
|
"bytes reverse"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("bytes reverse")
|
|
.input_output_types(vec![(Type::Binary, Type::Binary)])
|
|
.rest(
|
|
"rest",
|
|
SyntaxShape::CellPath,
|
|
"for a data structure input, reverse data at the given cell paths",
|
|
)
|
|
.category(Category::Bytes)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Reverse the bytes in the pipeline."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["convert", "inverse", "flip"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 0)?;
|
|
let arg = CellPathOnlyArgs::from(cell_paths);
|
|
operate(reverse, arg, input, call.head, engine_state.ctrlc.clone())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Reverse bytes `0x[1F FF AA AA]`",
|
|
example: "0x[1F FF AA AA] | bytes reverse",
|
|
result: Some(Value::Binary {
|
|
val: vec![0xAA, 0xAA, 0xFF, 0x1F],
|
|
span: Span::test_data(),
|
|
}),
|
|
},
|
|
Example {
|
|
description: "Reverse bytes `0x[FF AA AA]`",
|
|
example: "0x[FF AA AA] | bytes reverse",
|
|
result: Some(Value::Binary {
|
|
val: vec![0xAA, 0xAA, 0xFF],
|
|
span: Span::test_data(),
|
|
}),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
fn reverse(val: &Value, _args: &CellPathOnlyArgs, span: Span) -> Value {
|
|
match val {
|
|
Value::Binary {
|
|
val,
|
|
span: val_span,
|
|
} => {
|
|
let mut reversed_input = val.to_vec();
|
|
reversed_input.reverse();
|
|
Value::Binary {
|
|
val: reversed_input,
|
|
span: *val_span,
|
|
}
|
|
}
|
|
// Propagate errors by explicitly matching them before the final case.
|
|
Value::Error { .. } => val.clone(),
|
|
other => Value::Error {
|
|
error: ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "binary".into(),
|
|
wrong_type: other.get_type().to_string(),
|
|
dst_span: span,
|
|
src_span: other.expect_span(),
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(BytesReverse {})
|
|
}
|
|
}
|