Skip to content

refactor: deprecate mutable operations in ArrayView and update documentation #2667

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
merged 1 commit into from
Sep 4, 2025
Merged

refactor: deprecate mutable operations in ArrayView and update documentation #2667

Show file tree
Hide file tree
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
4 changes: 0 additions & 4 deletions array/README.mbt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,6 @@ test "array views" {
// Map view to new array
let doubled = view.map(x => x * 2)
inspect(doubled, content="[4, 6, 8]")

// Modify view in-place
view.map_inplace(x => x + 1)
inspect(arr, content="[1, 3, 4, 5, 5]")
}
```

Expand Down
1 change: 1 addition & 0 deletions array/pkg.generated.mbti
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ fn[A] ArrayView::iter(Self[A]) -> Iter[A]
fn[A] ArrayView::iter2(Self[A]) -> Iter2[Int, A]
fn[A : @string.ToStringView] ArrayView::join(Self[A], @string.View) -> String
fn[T, U] ArrayView::map(Self[T], (T) -> U raise?) -> Array[U] raise?
#deprecated
fn[T] ArrayView::map_inplace(Self[T], (T) -> T raise?) -> Unit raise?
fn[T, U] ArrayView::mapi(Self[T], (Int, T) -> U raise?) -> Array[U] raise?
fn[T] ArrayView::mapi_inplace(Self[T], (Int, T) -> T raise?) -> Unit raise?
Expand Down
7 changes: 1 addition & 6 deletions array/view.mbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,7 @@ pub fn[T, U] View::map(self : View[T], f : (T) -> U raise?) -> Array[U] raise? {
///|
/// Maps a function over the elements of the array view in place.
///
/// # Example
/// ```mbt
/// let v = [3, 4, 5]
/// v[1:].map_inplace((x) => {x + 1})
/// assert_eq(v, [3, 5, 6])
/// ```
#deprecated("ArrayView will be immutable, use Array if you need mutation")
pub fn[T] View::map_inplace(self : View[T], f : (T) -> T raise?) -> Unit raise? {
for i, v in self {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

cc @Guest0x0 this is another case where you want deprecation not working in the same package, we heave a function a deprecated, and a function b deprecated (b called a), but we can not simply remove b during migration period (similar to recursive ones). The workaround is the same, rename a to a private function, mark the public interface deprecated

self[i] = f(v)
Expand Down
10 changes: 0 additions & 10 deletions array/view_test.mbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,16 +153,6 @@ test "arrayview_map" {
@json.inspect(([1] : Array[Int])[1:].map(x => x), content=[])
}

///|
test "arrayview_map_inplace" {
let arr = [1, 2, 3]
arr[1:].map_inplace(x => x * 2)
inspect(arr.length(), content="3")
inspect(arr[0], content="1")
inspect(arr[1], content="4")
inspect(arr[2], content="6")
}

///|
test "arrayview_mapi" {
let arr = [1, 2, 3]
Expand Down
9 changes: 1 addition & 8 deletions builtin/arrayview.mbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,8 @@ pub fn[T] ArrayView::unsafe_get(self : ArrayView[T], index : Int) -> T {
/// Throws a panic if `index` is negative or greater than or equal to the length
/// of the array view.
///
/// Example:
///
/// ```moonbit
/// let arr = [1, 2, 3, 4, 5]
/// let view = arr[1:4] // view contains [2, 3, 4]
/// view.op_set(1, 42)
/// inspect(arr, content="[1, 2, 42, 4, 5]")
/// ```
///
#deprecated("ArrayView will be immutable, use array if you need mutation")
pub fn[T] ArrayView::op_set(
self : ArrayView[T],
index : Int,
Expand Down
8 changes: 0 additions & 8 deletions builtin/arrayview_test.mbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,6 @@ test "op_get" {
inspect([1, 2, 3][:][2], content="3")
}

///|
test "op_set" {
let v = [1, 2, 3][:]
inspect(v[1], content="2")
v[1] = 4
inspect(v[1], content="4")
}

///|
test "swap" {
let v = [1, 2, 3][:]
Expand Down
5 changes: 0 additions & 5 deletions builtin/panic_test.mbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,6 @@ test "panic array_as_view_get_index_error" {
[1, 2, 3][:][5] |> ignore
}

///|
test "panic array_as_view_set_index_error" {
[1, 2, 3][:][5] = 0
}

///|
test "panic array_as_view_swap_index_error" {
[1, 2, 3][:].swap(1, 9)
Expand Down
1 change: 1 addition & 0 deletions builtin/pkg.generated.mbti
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ fn[T] ArrayView::blit_to(Self[T], Self[T]) -> Unit
fn[T] ArrayView::length(Self[T]) -> Int
fn[T] ArrayView::op_as_view(Self[T], start? : Int, end? : Int) -> Self[T]
fn[T] ArrayView::op_get(Self[T], Int) -> T
#deprecated
fn[T] ArrayView::op_set(Self[T], Int, T) -> Unit
fn[T] ArrayView::swap(Self[T], Int, Int) -> Unit
fn[T] ArrayView::unsafe_get(Self[T], Int) -> T
Expand Down
Loading