Skip to content

chore(interpreter): update docs for slice_mut and slice_range #2714

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.

Sign up for GitHub

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

Merged
rakita merged 1 commit into from
Jul 15, 2025
Merged

chore(interpreter): update docs for slice_mut and slice_range #2714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions crates/interpreter/src/interpreter/shared_memory.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,13 @@ impl SharedMemory {
///
/// # Panics
///
/// Panics on out of bounds.
/// Panics on out of bounds access in debug builds only.
///
/// # Safety
///
/// In release builds, calling this method with an out-of-bounds range triggers undefined
/// behavior. Callers must ensure that the range is within the bounds of the memory (i.e.,
/// `range.end <= self.len()`).
#[inline]
#[cfg_attr(debug_assertions, track_caller)]
pub fn slice_range(&self, range: Range<usize>) -> Ref<'_, [u8]> {
Expand Down Expand Up @@ -270,7 +276,13 @@ impl SharedMemory {
///
/// # Panics
///
/// Panics on out of bounds.
/// Panics on out of bounds access in debug builds only.
///
/// # Safety
///
/// In release builds, calling this method with out-of-bounds parameters triggers undefined
/// behavior. Callers must ensure that `offset + size` does not exceed the length of the
/// memory.
#[inline]
#[cfg_attr(debug_assertions, track_caller)]
pub fn slice_mut(&mut self, offset: usize, size: usize) -> RefMut<'_, [u8]> {
Expand Down
Loading