mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 06:25:43 +02:00
Add bytes split
command (#14652)
Related #10708 # Description Add `bytes split` command. `bytes split` splits its input on the provided separator on binary values _and_ binary streams without collecting. The separator can be a multiple character string or multiple byte binary. It can be used when neither `split row` (not streaming over raw input) nor `lines` (streaming, but can only split on newlines) is right. The backing iterator implemented in this PR, `SplitRead`, can be used to implement a streaming `split row` in the future. # User-Facing Changes `bytes split` command added, which can be used to split binary values and raw streams using a separator. # Tests + Formatting - 🟢 toolkit fmt - 🟢 toolkit clippy - 🟢 toolkit test - 🟢 toolkit test stdlib # After Submitting Mention in release notes.
This commit is contained in:
@ -9,6 +9,7 @@ mod length;
|
||||
mod remove;
|
||||
mod replace;
|
||||
mod reverse;
|
||||
mod split;
|
||||
mod starts_with;
|
||||
|
||||
pub use add::BytesAdd;
|
||||
@ -22,4 +23,5 @@ pub use length::BytesLen;
|
||||
pub use remove::BytesRemove;
|
||||
pub use replace::BytesReplace;
|
||||
pub use reverse::BytesReverse;
|
||||
pub use split::BytesSplit;
|
||||
pub use starts_with::BytesStartsWith;
|
||||
|
109
crates/nu-command/src/bytes/split.rs
Normal file
109
crates/nu-command/src/bytes/split.rs
Normal file
@ -0,0 +1,109 @@
|
||||
use nu_engine::command_prelude::*;
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct BytesSplit;
|
||||
|
||||
impl Command for BytesSplit {
|
||||
fn name(&self) -> &str {
|
||||
"bytes split"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build("bytes split")
|
||||
.input_output_types(vec![(Type::Binary, Type::list(Type::Binary))])
|
||||
.required(
|
||||
"separator",
|
||||
SyntaxShape::OneOf(vec![SyntaxShape::Binary, SyntaxShape::String]),
|
||||
"Bytes or string that the input will be split on (must be non-empty).",
|
||||
)
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn description(&self) -> &str {
|
||||
"Split input into multiple items using a separator."
|
||||
}
|
||||
|
||||
fn search_terms(&self) -> Vec<&str> {
|
||||
vec!["separate", "stream"]
|
||||
}
|
||||
|
||||
fn examples(&self) -> Vec<Example> {
|
||||
vec![
|
||||
Example {
|
||||
example: r#"0x[66 6F 6F 20 62 61 72 20 62 61 7A 20] | bytes split 0x[20]"#,
|
||||
description: "Split a binary value using a binary separator",
|
||||
result: Some(Value::test_list(vec![
|
||||
Value::test_binary("foo"),
|
||||
Value::test_binary("bar"),
|
||||
Value::test_binary("baz"),
|
||||
Value::test_binary(""),
|
||||
])),
|
||||
},
|
||||
Example {
|
||||
example: r#"0x[61 2D 2D 62 2D 2D 63] | bytes split "--""#,
|
||||
description: "Split a binary value using a string separator",
|
||||
result: Some(Value::test_list(vec![
|
||||
Value::test_binary("a"),
|
||||
Value::test_binary("b"),
|
||||
Value::test_binary("c"),
|
||||
])),
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
fn run(
|
||||
&self,
|
||||
engine_state: &EngineState,
|
||||
stack: &mut Stack,
|
||||
call: &Call,
|
||||
input: PipelineData,
|
||||
) -> Result<PipelineData, ShellError> {
|
||||
let head = call.head;
|
||||
let Spanned {
|
||||
item: separator,
|
||||
span,
|
||||
}: Spanned<Vec<u8>> = call.req(engine_state, stack, 0)?;
|
||||
|
||||
if separator.is_empty() {
|
||||
return Err(ShellError::IncorrectValue {
|
||||
msg: "Separator can't be empty".into(),
|
||||
val_span: span,
|
||||
call_span: call.head,
|
||||
});
|
||||
}
|
||||
|
||||
let (split_read, md) = match input {
|
||||
PipelineData::Value(Value::Binary { val, .. }, md) => (
|
||||
ByteStream::read_binary(val, head, engine_state.signals().clone()).split(separator),
|
||||
md,
|
||||
),
|
||||
PipelineData::ByteStream(stream, md) => (stream.split(separator), md),
|
||||
input => {
|
||||
let span = input.span().unwrap_or(head);
|
||||
return Err(input.unsupported_input_error("bytes", span));
|
||||
}
|
||||
};
|
||||
if let Some(split) = split_read {
|
||||
Ok(split
|
||||
.map(move |part| match part {
|
||||
Ok(val) => Value::binary(val, head),
|
||||
Err(err) => Value::error(err, head),
|
||||
})
|
||||
.into_pipeline_data_with_metadata(head, engine_state.signals().clone(), md))
|
||||
} else {
|
||||
Ok(PipelineData::empty())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_examples() {
|
||||
use crate::test_examples;
|
||||
|
||||
test_examples(BytesSplit {})
|
||||
}
|
||||
}
|
@ -380,6 +380,7 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
|
||||
bind_command! {
|
||||
Bytes,
|
||||
BytesLen,
|
||||
BytesSplit,
|
||||
BytesStartsWith,
|
||||
BytesEndsWith,
|
||||
BytesReverse,
|
||||
|
Reference in New Issue
Block a user