Skip to content

Implement replace_with, a function similar to the one provided by the take_mut crate. #36186

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

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
65 changes: 65 additions & 0 deletions src/libcore/mem.rs
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,71 @@ pub fn replace<T>(dest: &mut T, mut src: T) -> T {
src
}

/// A guarding type which will abort upon drop.
///
/// This is used for catching unwinding and transforming it into abort.
///
/// The destructor should never be called naturally (use `mem::forget()`), and only when unwinding.
struct ExitGuard;

impl Drop for ExitGuard {
fn drop(&mut self) {
// To avoid unwinding, we abort (we panic, which is equivalent to abort inside an unwinding
// destructor) the program, which ensures that the destructor of the invalidated value
// isn't run, since this destructor ought to be called only if unwinding happens.
panic!("`replace_with` closure unwinded. For safety reasons, this will \
abort your program. Check the documentation");
}
}

/// Temporarily takes ownership of a value at a mutable location, and replace it with a new value
/// based on the old one.
///
/// We move out of reference temporarily, to apply a closure, returning a new value, which is then
/// placed at the original value's location.
///
/// # An important note
///
/// The behavior on panic (or to be more precise, unwinding) is specified to match the behavior of
/// panicking inside a destructor, which itself is simply specified to not unwind.
///
/// # Example
///
/// ```
/// use std::mem;
///
/// // Dump some stuff into a box.
/// let mut bx: Box<i32> = Box::new(200);
///
/// // Temporarily steal ownership.
/// mem::replace_with(&mut bx, |mut owned| {
/// owner = 5;
///
/// // The returned value is placed back in `&mut bx`.
/// Box::new(owner)
/// });
/// ```
#[inline]
#[unstable(feature = "replace_with", issue = "...")]
pub fn replace_with<T, F>(val: &mut T, closure: F)
where F: FnOnce(T) -> T {
// Guard against unwinding. Note that this is critical to safety, to avoid the value behind the
// reference `val` is not dropped twice during unwinding.
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of "to avoid the value...is not dropped", maybe " to avoid the value...being dropped" or just "to avoid dropping the value..."

Choose a reason for hiding this comment

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

your example in the comment uses mem::replace instead of mem::replace_with

let guard = ExitGuard;

unsafe {
// Take out the value behind the pointer.
let old = ptr::read(val);
// Run the closure.
let new = closure(old);
Copy link

Choose a reason for hiding this comment

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

s/closure/replace/

// Put the result back.
ptr::write(val, new);
}

// Forget the guard, to avoid panicking.
mem::forget(guard);
Copy link
Member

Choose a reason for hiding this comment

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

Fails with "Use of undeclared type or module mem". I believe this should just be forget(guard);

}

/// Disposes of a value.
///
/// While this does call the argument's implementation of `Drop`, it will not
Expand Down
25 changes: 25 additions & 0 deletions src/libcoretest/mem.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,31 @@ fn test_replace() {
assert!(y.is_some());
}

#[test]
fn test_replace_with() {
let mut x = Some("test".to_string());
replace_with(&mut x, |_| None);
assert!(x.is_none());
}

#[test]
fn test_replace_with_2() {
let mut x = Box::new(21);
replace_with(&mut x, |x| Box::new(x + 5));
assert_eq!(*x, 26);
}

#[test]
fn test_replace_with_3() {
let is_called = Cell::new(false);
let mut x = 2;
replace_with(&mut x, |_| {
is_called.set(true);
3
});
assert!(is_called.get());
}

#[test]
fn test_transmute_copy() {
assert_eq!(1, unsafe { transmute_copy(&1) });
Expand Down