Implementing ByteStream interuption on infinite stream (#13552)

# Description

This PR should address #13530 by explicitly handling ByteStreams. 

The issue can be replicated easily on linux by running:

```nushell
open /dev/urandom | into binary | bytes at ..10
```

Would leave the output hanging and with no way to cancel it, this was
likely because it was trying to collect the input stream and would not
complete.

I have also put in an error to say that using negative offsets for a
bytestream without a length cannot be used.

```nushell
~/git/nushell> open /dev/urandom | into binary | bytes at (-1)..
Error: nu:🐚:incorrect_value

  × Incorrect value.
   ╭─[entry #3:1:35]
 1 │ open /dev/urandom | into binary | bytes at (-1)..
   ·                                   ────┬─── ───┬──
   ·                                       │       ╰── encountered here
   ·                                       ╰── Negative range values cannot be used with streams that don't specify a length
   ╰────
   ```

# User-Facing Changes

No operation changes, only the warning you get back for negative offsets

# Tests + Formatting

Ran `toolkit check pr ` with no errors or warnings

Manual testing of the example commands above

---------

Co-authored-by: Ian Manske <ian.manske@pm.me>
Co-authored-by: Simon Curtis <simon.curtis@candc-uk.com>
This commit is contained in:
Simon Curtis 2025-01-11 21:28:08 +00:00 committed by GitHub
parent 0b71eb201c
commit f05162811c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 612 additions and 103 deletions

View file

@ -43,7 +43,12 @@ mod test_examples {
signature.operates_on_cell_paths(), signature.operates_on_cell_paths(),
), ),
); );
check_example_evaluates_to_expected_output(&example, cwd.as_path(), &mut engine_state); check_example_evaluates_to_expected_output(
cmd.name(),
&example,
cwd.as_path(),
&mut engine_state,
);
} }
check_all_signature_input_output_types_entries_have_examples( check_all_signature_input_output_types_entries_have_examples(

View file

@ -139,6 +139,7 @@ pub fn eval_block(
} }
pub fn check_example_evaluates_to_expected_output( pub fn check_example_evaluates_to_expected_output(
cmd_name: &str,
example: &Example, example: &Example,
cwd: &std::path::Path, cwd: &std::path::Path,
engine_state: &mut Box<EngineState>, engine_state: &mut Box<EngineState>,
@ -159,11 +160,17 @@ pub fn check_example_evaluates_to_expected_output(
// If the command you are testing requires to compare another case, then // If the command you are testing requires to compare another case, then
// you need to define its equality in the Value struct // you need to define its equality in the Value struct
if let Some(expected) = example.result.as_ref() { if let Some(expected) = example.result.as_ref() {
let expected = DebuggableValue(expected);
let result = DebuggableValue(&result);
assert_eq!( assert_eq!(
DebuggableValue(&result), result,
DebuggableValue(expected), expected,
"The example result differs from the expected value", "Error: The result of example '{}' for the command '{}' differs from the expected value.\n\nExpected: {:?}\nActual: {:?}\n",
) example.description,
cmd_name,
expected,
result,
);
} }
} }

View file

@ -44,7 +44,12 @@ mod test_examples {
signature.operates_on_cell_paths(), signature.operates_on_cell_paths(),
), ),
); );
check_example_evaluates_to_expected_output(&example, cwd.as_path(), &mut engine_state); check_example_evaluates_to_expected_output(
cmd.name(),
&example,
cwd.as_path(),
&mut engine_state,
);
} }
check_all_signature_input_output_types_entries_have_examples( check_all_signature_input_output_types_entries_have_examples(

View file

@ -1,15 +1,14 @@
use nu_cmd_base::{ use std::ops::Bound;
input_handler::{operate, CmdArgument},
util, use nu_cmd_base::input_handler::{operate, CmdArgument};
};
use nu_engine::command_prelude::*; use nu_engine::command_prelude::*;
use nu_protocol::Range; use nu_protocol::{IntRange, Range};
#[derive(Clone)] #[derive(Clone)]
pub struct BytesAt; pub struct BytesAt;
struct Arguments { struct Arguments {
indexes: Subbytes, range: IntRange,
cell_paths: Option<Vec<CellPath>>, cell_paths: Option<Vec<CellPath>>,
} }
@ -19,15 +18,6 @@ impl CmdArgument for Arguments {
} }
} }
impl From<(isize, isize)> for Subbytes {
fn from(input: (isize, isize)) -> Self {
Self(input.0, input.1)
}
}
#[derive(Clone, Copy)]
struct Subbytes(isize, isize);
impl Command for BytesAt { impl Command for BytesAt {
fn name(&self) -> &str { fn name(&self) -> &str {
"bytes at" "bytes at"
@ -44,6 +34,7 @@ impl Command for BytesAt {
(Type::table(), Type::table()), (Type::table(), Type::table()),
(Type::record(), Type::record()), (Type::record(), Type::record()),
]) ])
.allow_variants_without_examples(true)
.required("range", SyntaxShape::Range, "The range to get bytes.") .required("range", SyntaxShape::Range, "The range to get bytes.")
.rest( .rest(
"rest", "rest",
@ -68,86 +59,115 @@ impl Command for BytesAt {
call: &Call, call: &Call,
input: PipelineData, input: PipelineData,
) -> Result<PipelineData, ShellError> { ) -> Result<PipelineData, ShellError> {
let range: Range = call.req(engine_state, stack, 0)?; let range = match call.req(engine_state, stack, 0)? {
let indexes = match util::process_range(&range) { Range::IntRange(range) => range,
Ok(idxs) => idxs.into(), _ => {
Err(processing_error) => { return Err(ShellError::UnsupportedInput {
return Err(processing_error("could not perform subbytes", call.head)); msg: "Float ranges are not supported for byte streams".into(),
input: "value originates from here".into(),
msg_span: call.head,
input_span: call.head,
})
} }
}; };
let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 1)?; let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 1)?;
let cell_paths = (!cell_paths.is_empty()).then_some(cell_paths); let cell_paths = (!cell_paths.is_empty()).then_some(cell_paths);
let args = Arguments {
indexes,
cell_paths,
};
operate(action, args, input, call.head, engine_state.signals()) if let PipelineData::ByteStream(stream, metadata) = input {
let stream = stream.slice(call.head, call.arguments_span(), range)?;
Ok(PipelineData::ByteStream(stream, metadata))
} else {
operate(
map_value,
Arguments { range, cell_paths },
input,
call.head,
engine_state.signals(),
)
}
} }
fn examples(&self) -> Vec<Example> { fn examples(&self) -> Vec<Example> {
vec![ vec![
Example { Example {
description: "Get a subbytes `0x[10 01]` from the bytes `0x[33 44 55 10 01 13]`", description: "Extract bytes starting from a specific index",
example: " 0x[33 44 55 10 01 13] | bytes at 3..<4", example: "{ data: 0x[33 44 55 10 01 13 10] } | bytes at 3.. data",
result: Some(Value::test_binary(vec![0x10])),
},
Example {
description: "Get a subbytes `0x[10 01 13]` from the bytes `0x[33 44 55 10 01 13]`",
example: " 0x[33 44 55 10 01 13] | bytes at 3..6",
result: Some(Value::test_binary(vec![0x10, 0x01, 0x13])),
},
Example {
description: "Get the remaining characters from a starting index",
example: " { data: 0x[33 44 55 10 01 13] } | bytes at 3.. data",
result: Some(Value::test_record(record! { result: Some(Value::test_record(record! {
"data" => Value::test_binary(vec![0x10, 0x01, 0x13]), "data" => Value::test_binary(vec![0x10, 0x01, 0x13, 0x10]),
})), })),
}, },
Example { Example {
description: "Get the characters from the beginning until ending index", description: "Slice out `0x[10 01 13]` from `0x[33 44 55 10 01 13]`",
example: " 0x[33 44 55 10 01 13] | bytes at ..<4", example: "0x[33 44 55 10 01 13] | bytes at 3..5",
result: Some(Value::test_binary(vec![0x10, 0x01, 0x13])),
},
Example {
description: "Extract bytes from the start up to a specific index",
example: "0x[33 44 55 10 01 13 10] | bytes at ..4",
result: Some(Value::test_binary(vec![0x33, 0x44, 0x55, 0x10, 0x01])),
},
Example {
description: "Extract byte `0x[10]` using an exclusive end index",
example: "0x[33 44 55 10 01 13 10] | bytes at 3..<4",
result: Some(Value::test_binary(vec![0x10])),
},
Example {
description: "Extract bytes up to a negative index (inclusive)",
example: "0x[33 44 55 10 01 13 10] | bytes at ..-4",
result: Some(Value::test_binary(vec![0x33, 0x44, 0x55, 0x10])), result: Some(Value::test_binary(vec![0x33, 0x44, 0x55, 0x10])),
}, },
Example { Example {
description: description: "Slice bytes across multiple table columns",
"Or the characters from the beginning until ending index inside a table", example: r#"[[ColA ColB ColC]; [0x[11 12 13] 0x[14 15 16] 0x[17 18 19]]] | bytes at 1.. ColB ColC"#,
example: r#" [[ColA ColB ColC]; [0x[11 12 13] 0x[14 15 16] 0x[17 18 19]]] | bytes at 1.. ColB ColC"#,
result: Some(Value::test_list(vec![Value::test_record(record! { result: Some(Value::test_list(vec![Value::test_record(record! {
"ColA" => Value::test_binary(vec![0x11, 0x12, 0x13]), "ColA" => Value::test_binary(vec![0x11, 0x12, 0x13]),
"ColB" => Value::test_binary(vec![0x15, 0x16]), "ColB" => Value::test_binary(vec![0x15, 0x16]),
"ColC" => Value::test_binary(vec![0x18, 0x19]), "ColC" => Value::test_binary(vec![0x18, 0x19]),
})])), })])),
}, },
Example {
description: "Extract the last three bytes using a negative start index",
example: "0x[33 44 55 10 01 13 10] | bytes at (-3)..",
result: Some(Value::test_binary(vec![0x01, 0x13, 0x10])),
},
] ]
} }
} }
fn action(input: &Value, args: &Arguments, head: Span) -> Value { fn map_value(input: &Value, args: &Arguments, head: Span) -> Value {
let range = &args.indexes; let range = &args.range;
match input { match input {
Value::Binary { val, .. } => { Value::Binary { val, .. } => {
let len = val.len() as isize; let len = val.len() as u64;
let start = if range.0 < 0 { range.0 + len } else { range.0 }; let start: u64 = range.absolute_start(len);
let end = if range.1 < 0 { range.1 + len } else { range.1 }; let start: usize = match start.try_into() {
Ok(start) => start,
Err(_) => {
let span = input.span();
return Value::error(
ShellError::UnsupportedInput {
msg: format!(
"Absolute start position {start} was too large for your system arch."
),
input: args.range.to_string(),
msg_span: span,
input_span: span,
},
head,
);
}
};
if start > end { let bytes: Vec<u8> = match range.absolute_end(len) {
Value::binary(vec![], head) Bound::Unbounded => val[start..].into(),
} else { Bound::Included(end) => val[start..=end as usize].into(),
let val_iter = val.iter().skip(start as usize); Bound::Excluded(end) => val[start..end as usize].into(),
Value::binary( };
if end == isize::MAX {
val_iter.copied().collect::<Vec<u8>>() Value::binary(bytes, head)
} else {
val_iter.take((end - start + 1) as usize).copied().collect()
},
head,
)
}
} }
Value::Error { .. } => input.clone(), Value::Error { .. } => input.clone(),
other => Value::error( other => Value::error(
ShellError::UnsupportedInput { ShellError::UnsupportedInput {
msg: "Only binary values are supported".into(), msg: "Only binary values are supported".into(),
@ -159,3 +179,14 @@ fn action(input: &Value, args: &Arguments, head: Span) -> Value {
), ),
} }
} }
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_examples() {
use crate::test_examples;
test_examples(BytesAt {})
}
}

View file

@ -61,7 +61,12 @@ mod test_examples {
signature.operates_on_cell_paths(), signature.operates_on_cell_paths(),
), ),
); );
check_example_evaluates_to_expected_output(&example, cwd.as_path(), &mut engine_state); check_example_evaluates_to_expected_output(
cmd.name(),
&example,
cwd.as_path(),
&mut engine_state,
);
} }
check_all_signature_input_output_types_entries_have_examples( check_all_signature_input_output_types_entries_have_examples(

View file

@ -1,6 +1,4 @@
use nu_engine::command_prelude::*; use nu_engine::command_prelude::*;
use nu_protocol::Signals;
use std::io::{self, Read};
#[derive(Clone)] #[derive(Clone)]
pub struct Skip; pub struct Skip;
@ -96,22 +94,10 @@ impl Command for Skip {
PipelineData::ByteStream(stream, metadata) => { PipelineData::ByteStream(stream, metadata) => {
if stream.type_().is_binary_coercible() { if stream.type_().is_binary_coercible() {
let span = stream.span(); let span = stream.span();
if let Some(mut reader) = stream.reader() { Ok(PipelineData::ByteStream(
// Copy the number of skipped bytes into the sink before proceeding stream.skip(span, n as u64)?,
io::copy(&mut (&mut reader).take(n as u64), &mut io::sink()) metadata,
.err_span(span)?; ))
Ok(PipelineData::ByteStream(
ByteStream::read(
reader,
call.head,
Signals::empty(),
ByteStreamType::Binary,
),
metadata,
))
} else {
Ok(PipelineData::Empty)
}
} else { } else {
Err(ShellError::OnlySupportsThisInputType { Err(ShellError::OnlySupportsThisInputType {
exp_input_type: "list, binary or range".into(), exp_input_type: "list, binary or range".into(),

View file

@ -1,6 +1,5 @@
use nu_engine::command_prelude::*; use nu_engine::command_prelude::*;
use nu_protocol::Signals; use nu_protocol::Signals;
use std::io::Read;
#[derive(Clone)] #[derive(Clone)]
pub struct Take; pub struct Take;
@ -89,20 +88,11 @@ impl Command for Take {
)), )),
PipelineData::ByteStream(stream, metadata) => { PipelineData::ByteStream(stream, metadata) => {
if stream.type_().is_binary_coercible() { if stream.type_().is_binary_coercible() {
if let Some(reader) = stream.reader() { let span = stream.span();
// Just take 'rows' bytes off the stream, mimicking the binary behavior Ok(PipelineData::ByteStream(
Ok(PipelineData::ByteStream( stream.take(span, rows_desired as u64)?,
ByteStream::read( metadata,
reader.take(rows_desired as u64), ))
head,
Signals::empty(),
ByteStreamType::Binary,
),
metadata,
))
} else {
Ok(PipelineData::Empty)
}
} else { } else {
Err(ShellError::OnlySupportsThisInputType { Err(ShellError::OnlySupportsThisInputType {
exp_input_type: "list, binary or range".into(), exp_input_type: "list, binary or range".into(),

View file

@ -0,0 +1,72 @@
use nu_test_support::nu;
#[test]
pub fn returns_error_for_relative_range_on_infinite_stream() {
let actual = nu!("nu --testbin iecho 3 | bytes at ..-3");
assert!(
actual.err.contains(
"Relative range values cannot be used with streams that don't have a known length"
),
"Expected error message for negative range with infinite stream"
);
}
#[test]
pub fn returns_bytes_for_fixed_range_on_infinite_stream_including_end() {
let actual = nu!("nu --testbin iecho 3 | bytes at ..10 | decode");
assert_eq!(
actual.out, "33333",
"Expected bytes from index 0 to 10, but got different output"
);
}
#[test]
pub fn returns_bytes_for_fixed_range_on_infinite_stream_excluding_end() {
let actual = nu!("nu --testbin iecho 3 | bytes at ..<9 | decode");
assert_eq!(
actual.out, "3333",
"Expected bytes from index 0 to 8, but got different output"
);
}
#[test]
pub fn test_string_returns_correct_slice_for_simple_positive_slice() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at ..4 | decode");
assert_eq!(actual.out, "Hello");
}
#[test]
pub fn test_string_returns_correct_slice_for_negative_start() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at (-5)..10 | decode");
assert_eq!(actual.out, "World");
}
#[test]
pub fn test_string_returns_correct_slice_for_negative_end() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at ..-7 | decode");
assert_eq!(actual.out, "Hello");
}
#[test]
pub fn test_string_returns_correct_slice_for_empty_slice() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at 5..<5 | decode");
assert_eq!(actual.out, "");
}
#[test]
pub fn test_string_returns_correct_slice_for_out_of_bounds() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at ..20 | decode");
assert_eq!(actual.out, "Hello World");
}
#[test]
pub fn test_string_returns_correct_slice_for_invalid_range() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at 11..5 | decode");
assert_eq!(actual.out, "");
}
#[test]
pub fn test_string_returns_correct_slice_for_max_end() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at 6..<11 | decode");
assert_eq!(actual.out, "World");
}

View file

@ -1 +1,2 @@
mod at;
mod collect; mod collect;

View file

@ -653,6 +653,18 @@ pub enum ShellError {
creation_site: Span, creation_site: Span,
}, },
/// Attempted to us a relative range on an infinite stream
///
/// ## Resolution
///
/// Ensure that either the range is absolute or the stream has a known length.
#[error("Relative range values cannot be used with streams that don't have a known length")]
#[diagnostic(code(nu::shell::relative_range_on_infinite_stream))]
RelativeRangeOnInfiniteStream {
#[label = "Relative range values cannot be used with streams that don't have a known length"]
span: Span,
},
/// An error happened while performing an external command. /// An error happened while performing an external command.
/// ///
/// ## Resolution /// ## Resolution

View file

@ -1,8 +1,9 @@
//! Module managing the streaming of raw bytes between pipeline elements //! Module managing the streaming of raw bytes between pipeline elements
#[cfg(feature = "os")] #[cfg(feature = "os")]
use crate::process::{ChildPipe, ChildProcess}; use crate::process::{ChildPipe, ChildProcess};
use crate::{ErrSpan, IntoSpanned, PipelineData, ShellError, Signals, Span, Type, Value}; use crate::{ErrSpan, IntRange, IntoSpanned, PipelineData, ShellError, Signals, Span, Type, Value};
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use std::ops::Bound;
#[cfg(unix)] #[cfg(unix)]
use std::os::fd::OwnedFd; use std::os::fd::OwnedFd;
#[cfg(windows)] #[cfg(windows)]
@ -220,6 +221,79 @@ impl ByteStream {
) )
} }
pub fn skip(self, span: Span, n: u64) -> Result<Self, ShellError> {
let known_size = self.known_size.map(|len| len.saturating_sub(n));
if let Some(mut reader) = self.reader() {
// Copy the number of skipped bytes into the sink before proceeding
io::copy(&mut (&mut reader).take(n), &mut io::sink()).err_span(span)?;
Ok(
ByteStream::read(reader, span, Signals::empty(), ByteStreamType::Binary)
.with_known_size(known_size),
)
} else {
Err(ShellError::TypeMismatch {
err_message: "expected readable stream".into(),
span,
})
}
}
pub fn take(self, span: Span, n: u64) -> Result<Self, ShellError> {
let known_size = self.known_size.map(|s| s.min(n));
if let Some(reader) = self.reader() {
Ok(ByteStream::read(
reader.take(n),
span,
Signals::empty(),
ByteStreamType::Binary,
)
.with_known_size(known_size))
} else {
Err(ShellError::TypeMismatch {
err_message: "expected readable stream".into(),
span,
})
}
}
pub fn slice(
self,
val_span: Span,
call_span: Span,
range: IntRange,
) -> Result<Self, ShellError> {
if let Some(len) = self.known_size {
let start = range.absolute_start(len);
let stream = self.skip(val_span, start);
match range.absolute_end(len) {
Bound::Unbounded => stream,
Bound::Included(end) | Bound::Excluded(end) if end < start => {
stream.and_then(|s| s.take(val_span, 0))
}
Bound::Included(end) => {
let distance = end - start + 1;
stream.and_then(|s| s.take(val_span, distance.min(len)))
}
Bound::Excluded(end) => {
let distance = end - start;
stream.and_then(|s| s.take(val_span, distance.min(len)))
}
}
} else if range.is_relative() {
Err(ShellError::RelativeRangeOnInfiniteStream { span: call_span })
} else {
let start = range.start() as u64;
let stream = self.skip(val_span, start);
match range.distance() {
Bound::Unbounded => stream,
Bound::Included(distance) => stream.and_then(|s| s.take(val_span, distance)),
Bound::Excluded(distance) => stream.and_then(|s| s.take(val_span, distance - 1)),
}
}
}
/// Create a [`ByteStream`] from a string. The type of the stream is always `String`. /// Create a [`ByteStream`] from a string. The type of the stream is always `String`.
pub fn read_string(string: String, span: Span, signals: Signals) -> Self { pub fn read_string(string: String, span: Span, signals: Signals) -> Self {
let len = string.len(); let len = string.len();

View file

@ -81,10 +81,46 @@ mod int_range {
self.start self.start
} }
// Resolves the absolute start position given the length of the input value
pub fn absolute_start(&self, len: u64) -> u64 {
let max_index = len - 1;
match self.start {
start if start < 0 => len.saturating_sub(start.unsigned_abs()),
start => max_index.min(start as u64),
}
}
/// Returns the distance between the start and end of the range
/// The result will always be 0 or positive
pub fn distance(&self) -> Bound<u64> {
match self.end {
Bound::Unbounded => Bound::Unbounded,
Bound::Included(end) if self.start > end => Bound::Included(0),
Bound::Excluded(end) if self.start > end => Bound::Excluded(0),
Bound::Included(end) => Bound::Included((end - self.start) as u64),
Bound::Excluded(end) => Bound::Excluded((end - self.start) as u64),
}
}
pub fn end(&self) -> Bound<i64> { pub fn end(&self) -> Bound<i64> {
self.end self.end
} }
pub fn absolute_end(&self, len: u64) -> Bound<u64> {
let max_index = len - 1;
match self.end {
Bound::Unbounded => Bound::Unbounded,
Bound::Included(i) => Bound::Included(match i {
i if i < 0 => len.saturating_sub(i.unsigned_abs()),
i => max_index.min(i as u64),
}),
Bound::Excluded(i) => Bound::Excluded(match i {
i if i < 0 => len.saturating_sub(i.unsigned_abs()),
i => len.min(i as u64),
}),
}
}
pub fn step(&self) -> i64 { pub fn step(&self) -> i64 {
self.step self.step
} }
@ -93,6 +129,21 @@ mod int_range {
self.end == Bound::Unbounded self.end == Bound::Unbounded
} }
pub fn is_relative(&self) -> bool {
self.is_start_relative() || self.is_end_relative()
}
pub fn is_start_relative(&self) -> bool {
self.start < 0
}
pub fn is_end_relative(&self) -> bool {
match self.end {
Bound::Included(end) | Bound::Excluded(end) => end < 0,
_ => false,
}
}
pub fn contains(&self, value: i64) -> bool { pub fn contains(&self, value: i64) -> bool {
if self.step < 0 { if self.step < 0 {
// Decreasing range // Decreasing range

View file

@ -0,0 +1 @@
mod pipeline;

View file

@ -0,0 +1,268 @@
use nu_protocol::{ast::RangeInclusion, ByteStream, IntRange, Signals, Span, Value};
#[test]
pub fn test_simple_positive_slice_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(0, 5, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
}
#[test]
pub fn test_negative_start_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(-5, 11, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
}
#[test]
pub fn test_negative_end_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(0, -6, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
}
#[test]
pub fn test_negative_start_and_end_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(-5, -2, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Wor");
}
#[test]
pub fn test_empty_slice_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(5, 5, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "");
}
#[test]
pub fn test_out_of_bounds_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(0, 20, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello World");
}
#[test]
pub fn test_invalid_range_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(11, 5, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "");
}
#[test]
pub fn test_max_end_exclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(6, i64::MAX, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
}
#[test]
pub fn test_simple_positive_slice_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(0, 5, RangeInclusion::RightExclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
}
#[test]
pub fn test_negative_start_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(-5, 11, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
}
#[test]
pub fn test_negative_end_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(0, -7, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
}
#[test]
pub fn test_negative_start_and_end_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(-5, -1, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
}
#[test]
pub fn test_empty_slice_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(5, 5, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, " ");
}
#[test]
pub fn test_out_of_bounds_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(0, 20, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello World");
}
#[test]
pub fn test_invalid_range_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(11, 5, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "");
}
#[test]
pub fn test_max_end_inclusive() {
let data = b"Hello World".to_vec();
let stream = ByteStream::read_binary(data, Span::test_data(), Signals::empty());
let sliced = stream
.slice(
Span::test_data(),
Span::test_data(),
create_range(6, i64::MAX, RangeInclusion::Inclusive),
)
.unwrap();
let result = sliced.into_bytes().unwrap();
let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
}
fn create_range(start: i64, end: i64, inclusion: RangeInclusion) -> IntRange {
IntRange::new(
Value::int(start, Span::unknown()),
Value::nothing(Span::test_data()),
Value::int(end, Span::unknown()),
inclusion,
Span::unknown(),
)
.unwrap()
}

View file

@ -0,0 +1 @@
mod byte_stream;