forked from extern/nushell
a52386e837
# Description Our `ShellError` at the moment has a `std::mem::size_of<ShellError>` of 136 bytes (on AMD64). As a result `Value` directly storing the struct also required 136 bytes (thanks to alignment requirements). This change stores the `Value::Error` `ShellError` on the heap. Pro: - Value now needs just 80 bytes - Should be 1 cacheline less (still at least 2 cachelines) Con: - More small heap allocations when dealing with `Value::Error` - More heap fragmentation - Potential for additional required memcopies # Further code changes Includes a small refactor of `try` due to a type mismatch in its large match. # User-Facing Changes None for regular users. Plugin authors may have to update their matches on `Value` if they use `nu-protocol` Needs benchmarking to see if there is a benefit in real world workloads. **Update** small improvements in runtime for workloads with high volume of values. Significant reduction in maximum resident set size, when many values are held in memory. # Tests + Formatting
92 lines
2.7 KiB
Rust
92 lines
2.7 KiB
Rust
use crate::input_handler::{operate, CellPathOnlyArgs};
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::{
|
|
ast::Call, ast::CellPath, engine::Command, engine::EngineState, engine::Stack, Category,
|
|
Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"ansi strip"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("ansi strip")
|
|
.input_output_types(vec![(Type::String, Type::String)])
|
|
.rest(
|
|
"cell path",
|
|
SyntaxShape::CellPath,
|
|
"for a data structure input, remove ANSI sequences from strings at the given cell paths",
|
|
)
|
|
.category(Category::Platform)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Strip ANSI escape sequences from a string."
|
|
}
|
|
|
|
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(action, arg, input, call.head, engine_state.ctrlc.clone())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Strip ANSI escape sequences from a string",
|
|
example: r#"$'(ansi green)(ansi cursor_on)hello' | ansi strip"#,
|
|
result: Some(Value::test_string("hello")),
|
|
}]
|
|
}
|
|
}
|
|
|
|
fn action(input: &Value, _args: &CellPathOnlyArgs, command_span: Span) -> Value {
|
|
match input {
|
|
Value::String { val, span } => {
|
|
Value::string(nu_utils::strip_ansi_likely(val).to_string(), *span)
|
|
}
|
|
other => {
|
|
let got = format!("value is {}, not string", other.get_type());
|
|
|
|
Value::Error {
|
|
error: Box::new(ShellError::TypeMismatch {
|
|
err_message: got,
|
|
span: other.span().unwrap_or(command_span),
|
|
}),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::{action, SubCommand};
|
|
use nu_protocol::{Span, Value};
|
|
|
|
#[test]
|
|
fn examples_work_as_expected() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
|
|
#[test]
|
|
fn test_stripping() {
|
|
let input_string =
|
|
Value::test_string("\u{1b}[3;93;41mHello\u{1b}[0m \u{1b}[1;32mNu \u{1b}[1;35mWorld");
|
|
let expected = Value::test_string("Hello Nu World");
|
|
|
|
let actual = action(&input_string, &vec![].into(), Span::test_data());
|
|
assert_eq!(actual, expected);
|
|
}
|
|
}
|