Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add splice method to Bytes #6823

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

SwayStar123
Copy link
Collaborator

@SwayStar123 SwayStar123 commented Jan 9, 2025

Description

Adds a splice method to bytes that lets you select start and end indices, and returns the range of bytes, removing them from the original bytes.

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@SwayStar123 SwayStar123 self-assigned this Jan 9, 2025
@SwayStar123 SwayStar123 added enhancement New feature or request lib: std Standard library labels Jan 9, 2025
@SwayStar123 SwayStar123 marked this pull request as ready for review January 9, 2025 11:52
@SwayStar123 SwayStar123 requested review from a team as code owners January 9, 2025 11:52
@K1-R1
Copy link
Member

K1-R1 commented Jan 9, 2025

I like the addition of splice, but I think we should match Rust's Vec impl https://doc.rust-lang.org/std/vec/struct.Vec.html#method.splice by taking a second optional param replace_with

if splice_len != replace_with.len() && tail_len > 0 {
let src = self.buf.ptr().add_uint_offset(end);
let dst = self.buf.ptr().add_uint_offset(start + replace_with.len());
// Use temporary buffer to safely handle overlapping memory
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need this temp if you read [end..] from the original buffer? I think you don´t, and you could save this temp copy.

Comment on lines +170 to +186
#[test()]
fn bytes_splice_replace_empty_bytes() {
let (mut bytes, a, b, c) = setup();
// bytes = [5, 7, 9]
let replacement = Bytes::new();
// Remove [0..1) => [5], replace with []
let spliced = bytes.splice(0, 1, replacement);

// bytes => [7, 9]
assert(bytes.len() == 2);
assert(bytes.get(0).unwrap() == b);
assert(bytes.get(1).unwrap() == c);

// spliced => [5]
assert(spliced.len() == 1);
assert(spliced.get(0).unwrap() == a);
}
Copy link
Contributor

@jjcnn jjcnn Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This case additonally tests one of the situations where the end of the original buffer overlaps with the end of the new buffer, i.e., the case where you need the temporary buffer.

As a regression test you should probably add a test for the other case, i.e,

// bytes = [5, 7, 9]
// Remove [0..1] => [5], replace with [10, 12]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lib: std Standard library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants