# 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
98 lines
2.6 KiB
Rust
98 lines
2.6 KiB
Rust
use nu_engine::CallExt;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type,
|
|
Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct StrCollect;
|
|
|
|
impl Command for StrCollect {
|
|
fn name(&self) -> &str {
|
|
"str collect"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("str collect")
|
|
.input_output_types(vec![(Type::List(Box::new(Type::String)), Type::String)])
|
|
.optional(
|
|
"separator",
|
|
SyntaxShape::String,
|
|
"optional separator to use when creating string",
|
|
)
|
|
.category(Category::Deprecated)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Deprecated command."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let separator: Option<String> = call.opt(engine_state, stack, 0)?;
|
|
|
|
let config = engine_state.get_config();
|
|
|
|
// let output = input.collect_string(&separator.unwrap_or_default(), &config)?;
|
|
// Hmm, not sure what we actually want. If you don't use debug_string, Date comes out as human readable
|
|
// which feels funny
|
|
let mut strings: Vec<String> = vec![];
|
|
|
|
for value in input {
|
|
match value {
|
|
Value::Error { error } => {
|
|
return Err(*error);
|
|
}
|
|
value => {
|
|
strings.push(value.debug_string("\n", config));
|
|
}
|
|
}
|
|
}
|
|
|
|
let output = if let Some(separator) = separator {
|
|
strings.join(&separator)
|
|
} else {
|
|
strings.join("")
|
|
};
|
|
|
|
Ok(Value::String {
|
|
val: output,
|
|
span: call.head,
|
|
}
|
|
.into_pipeline_data())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Create a string from input",
|
|
example: "['nu', 'shell'] | str collect",
|
|
result: Some(Value::test_string("nushell")),
|
|
},
|
|
Example {
|
|
description: "Create a string from input with a separator",
|
|
example: "['nu', 'shell'] | str collect '-'",
|
|
result: Some(Value::test_string("nu-shell")),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(StrCollect {})
|
|
}
|
|
}
|