#array #borrow #index

arref

Make borrow mut elements from an array easier

1 unstable release

0.1.0 Sep 26, 2022

#52 in #borrow

Download history 2/week @ 2023-11-20 25/week @ 2023-11-27 22/week @ 2023-12-04 17/week @ 2023-12-11 14/week @ 2023-12-18 22/week @ 2023-12-25 8/week @ 2024-01-01 23/week @ 2024-01-08 11/week @ 2024-01-15 13/week @ 2024-02-05 41/week @ 2024-02-12 44/week @ 2024-02-19 53/week @ 2024-02-26 29/week @ 2024-03-04

168 downloads per month
Used in 8 crates (5 directly)

MIT license

6KB
50 lines

Getting mutable references to two elements from the same array is hard. This tiny lib provides method to make it easier.

[array_mut_ref!] checks whether the user borrows the same element at runtime.

use arref::array_mut_ref;
let mut arr = vec![1, 2, 3, 4];
let (a, b) = array_mut_ref!(&mut arr, [1, 2]);
assert_eq!(*a, 2);
assert_eq!(*b, 3);
let (a, b, c) = array_mut_ref!(&mut arr, [1, 2, 0]);
assert_eq!(*c, 1);

// ⚠️ The following code will panic. Because we borrow the same element twice.
// let (a, b) = array_mut_ref!(&mut arr, [1, 1]);

Alternatively, you can use [mut_twice]. It won't panic if you borrow the same element twice. It'll return an Err(&mut T) instead.

use arref::mut_twice;
let mut arr = vec![1, 2, 3];
let (a, b) = mut_twice(&mut arr, 1, 2).unwrap();
assert_eq!(*a, 2);
assert_eq!(*b, 3);
let result = mut_twice(&mut arr, 1, 1);
assert!(result.is_err());
if let Err(v) = result {
    assert_eq!(*v, 2);
}

lib.rs:

Getting mutable references to two elements from the same array is hard. This tiny lib provides method to make it easier.

[array_mut_ref!] checks whether the user borrows the same element at runtime.

use arref::array_mut_ref;
let mut arr = vec![1, 2, 3, 4];
let (a, b) = array_mut_ref!(&mut arr, [1, 2]);
assert_eq!(*a, 2);
assert_eq!(*b, 3);
let (a, b, c) = array_mut_ref!(&mut arr, [1, 2, 0]);
assert_eq!(*c, 1);

// ⚠️ The following code will panic. Because we borrow the same element twice.
// let (a, b) = array_mut_ref!(&mut arr, [1, 1]);

Alternatively, you can use [mut_twice]. It won't panic if you borrow the same element twice. It'll return an Err(&mut T) instead.

use arref::mut_twice;
let mut arr = vec![1, 2, 3];
let (a, b) = mut_twice(&mut arr, 1, 2).unwrap();
assert_eq!(*a, 2);
assert_eq!(*b, 3);
let result = mut_twice(&mut arr, 1, 1);
assert!(result.is_err());
if let Err(v) = result {
    assert_eq!(*v, 2);
}

No runtime deps